Merge 2261e2f into a301a92

nextras · May 7, 2020 · 54bd02b · 54bd02b
2 parents a301a92 + 2261e2f
commit 54bd02b
Show file tree

Hide file tree

Showing 12 changed files with 135 additions and 35 deletions.
diff --git a/src/Bridges/NetteTracy/ConnectionPanel.php b/src/Bridges/NetteTracy/ConnectionPanel.php
@@ -8,7 +8,7 @@
 
 namespace Nextras\Dbal\Bridges\NetteTracy;
 
-use Nextras\Dbal\DriverException;
+use Nextras\Dbal\Drivers\Exception\DriverException;
 use Nextras\Dbal\IConnection;
 use Nextras\Dbal\ILogger;
 use Nextras\Dbal\Platforms\IPlatform;
@@ -67,7 +67,7 @@ public function onDisconnect(): void
 	}
 
 
-	public function onQuery(string $sqlQuery, float $timeTaken, ?Result $result, ?DriverException $exception): void
+	public function onQuery(string $sqlQuery, float $timeTaken, ?Result $result): void
 	{
 		$this->count++;
 		if ($this->count > $this->maxQueries) {
@@ -84,6 +84,11 @@ public function onQuery(string $sqlQuery, float $timeTaken, ?Result $result, ?Dr
 	}
 
 
+	public function onQueryException(string $sqlQuery, float $timeTaken, ?DriverException $exception): void
+	{
+	}
+
+
 	public function getTab(): ?string
 	{
 		$count = $this->count;

diff --git a/src/Bridges/SymfonyBundle/DataCollector/QueryDataCollector.php b/src/Bridges/SymfonyBundle/DataCollector/QueryDataCollector.php
@@ -8,8 +8,7 @@
 
 namespace Nextras\Dbal\Bridges\SymfonyBundle\DataCollector;
 
-use Nextras\Dbal\Bridges\NetteTracy\ConnectionPanel;
-use Nextras\Dbal\DriverException;
+use Nextras\Dbal\Drivers\Exception\DriverException;
 use Nextras\Dbal\IConnection;
 use Nextras\Dbal\ILogger;
 use Nextras\Dbal\Platforms\IPlatform;
@@ -135,7 +134,7 @@ public function onDisconnect(): void
 	}
 
 
-	public function onQuery(string $sqlQuery, float $timeTaken, ?Result $result, ?DriverException $exception): void
+	public function onQuery(string $sqlQuery, float $timeTaken, ?Result $result): void
 	{
 		$this->data['count']++;
 		if ($this->data['count'] > 100) {
@@ -149,4 +148,9 @@ public function onQuery(string $sqlQuery, float $timeTaken, ?Result $result, ?Dr
 			$result ? $result->count() : null,
 		];
 	}
+
+
+	public function onQueryException(string $sqlQuery, float $timeTaken, ?DriverException $exception): void
+	{
+	}
 }
diff --git a/src/Connection.php b/src/Connection.php
@@ -270,15 +270,8 @@ public function rollbackTransaction(): void
 	}
 
 
-	/**
-	 * Returns current connection's transaction index.
-	 * 0 = no running transaction
-	 * 1 = basic transaction
-	 * >1 = nested transaction through savepoints
-	 * Todo: Add this method to interface in v4
-	 * @return int
-	 */
-	public function getTransactionIndex(): int
+	/** @inheritdoc */
+	public function getTransactionNestedIndex(): int
 	{
 		return $this->nestedTransactionIndex;
 	}

diff --git a/src/Drivers/Sqlsrv/SqlsrvDriver.php b/src/Drivers/Sqlsrv/SqlsrvDriver.php
@@ -207,7 +207,7 @@ public function beginTransaction(): void
 		$time = microtime(true);
 		$result = sqlsrv_begin_transaction($this->connection);
 		$timeTaken = microtime(true) - $time;
-		$this->logger->onQuery('BEGIN TRANSACTION', $timeTaken, null, null);
+		$this->logger->onQuery('BEGIN TRANSACTION', $timeTaken, null);
 		if (!$result) {
 			$this->throwErrors();
 		}
@@ -220,7 +220,7 @@ public function commitTransaction(): void
 		$time = microtime(true);
 		$result = sqlsrv_commit($this->connection);
 		$timeTaken = microtime(true) - $time;
-		$this->logger->onQuery('COMMIT TRANSACTION', $timeTaken, null, null);
+		$this->logger->onQuery('COMMIT TRANSACTION', $timeTaken, null);
 		if (!$result) {
 			$this->throwErrors();
 		}
@@ -233,7 +233,7 @@ public function rollbackTransaction(): void
 		$time = microtime(true);
 		$result = sqlsrv_rollback($this->connection);
 		$timeTaken = microtime(true) - $time;
-		$this->logger->onQuery('ROLLBACK TRANSACTION', $timeTaken, null, null);
+		$this->logger->onQuery('ROLLBACK TRANSACTION', $timeTaken, null);
 		if (!$result) {
 			$this->throwErrors();
 		}

diff --git a/src/IConnection.php b/src/IConnection.php
@@ -133,6 +133,15 @@ public function commitTransaction(): void;
 	public function rollbackTransaction(): void;
 
 
+	/**
+	 * Returns current connection's transaction nested index.
+	 * 0 = no running transaction
+	 * 1 = basic transaction
+	 * >1 = nested transaction through save-points
+	 */
+	public function getTransactionNestedIndex(): int;
+
+
 	/**
 	 * Creates a savepoint.
 	 * @throws DriverException

diff --git a/src/ILogger.php b/src/ILogger.php
@@ -28,5 +28,15 @@ public function onDisconnect(): void;
 	/**
 	 * When SQL query is executed on connection.
 	 */
-	public function onQuery(string $sqlQuery, float $timeTaken, ?Result $result, ?\Nextras\Dbal\Drivers\Exception\DriverException $exception): void;
+	public function onQuery(string $sqlQuery, float $timeTaken, ?Result $result): void;
+
+
+	/**
+	 * When SQL query execution fails on connection.
+	 */
+	public function onQueryException(
+		string $sqlQuery,
+		float $timeTaken,
+		?\Nextras\Dbal\Drivers\Exception\DriverException $exception
+	): void;
 }
diff --git a/src/Utils/CallbackQueryLogger.php b/src/Utils/CallbackQueryLogger.php
@@ -0,0 +1,68 @@
+<?php declare(strict_types = 1);
+
+namespace Nextras\Dbal\Utils;
+
+use Nextras\Dbal\Drivers\Exception\DriverException;
+use Nextras\Dbal\ILogger;
+use Nextras\Dbal\Result\Result;
+
+
+/**
+ * Support class to ease BC with Dbal 3.0.
+ *
+ * Replace
+ *
+ * <code>
+ * $connection->onQuery[] = function(...) {...};
+ * </code>
+ *
+ * with
+ *
+ * <code>
+ * $connection->addLogger(new CallbackQueryLogger(function (...) {...}));
+ * </code>
+ * @deprecated
+ */
+class CallbackQueryLogger implements ILogger
+{
+	/**
+	 * @var callable
+	 * @phpstan-var callable(string $sqlQuery, float $timeTaken, ?Result $result): void
+	 */
+	private $callback;
+
+
+	/**
+	 * @phpstan-param callable(string $sqlQuery, float $timeTaken, ?Result $result): void $callback
+	 */
+	public function __construct(callable $callback)
+	{
+		$this->callback = $callback;
+	}
+
+
+	public function onConnect(): void
+	{
+	}
+
+
+	public function onDisconnect(): void
+	{
+	}
+
+
+	public function onQuery(string $sqlQuery, float $timeTaken, ?Result $result): void
+	{
+		$callback = $this->callback;
+		$callback($sqlQuery, $timeTaken, $result);
+	}
+
+
+	public function onQueryException(
+		string $sqlQuery,
+		float $timeTaken,
+		?DriverException $exception
+	): void
+	{
+	}
+}
diff --git a/src/Utils/LoggerHelper.php b/src/Utils/LoggerHelper.php
@@ -8,7 +8,7 @@
 
 namespace Nextras\Dbal\Utils;
 
-use Nextras\Dbal\DriverException;
+use Nextras\Dbal\Drivers\Exception\DriverException;
 use Nextras\Dbal\Drivers\IDriver;
 use Nextras\Dbal\ILogger;
 use Nextras\Dbal\Result\Result;
@@ -32,15 +32,13 @@ public static function loggedQuery(IDriver $driver, ILogger $logger, string $sql
 			$logger->onQuery(
 				$sqlQuery,
 				$driver->getQueryElapsedTime(),
-				$result,
-				null // exception
+				$result
 			);
 			return $result;
 		} catch (DriverException $exception) {
-			$logger->onQuery(
+			$logger->onQueryException(
 				$sqlQuery,
 				$driver->getQueryElapsedTime(),
-				null, // result
 				$exception
 			);
 			throw $exception;

diff --git a/src/Utils/MultiLogger.php b/src/Utils/MultiLogger.php
@@ -38,10 +38,18 @@ public function onDisconnect(): void
 	}
 
 
-	public function onQuery(string $sqlQuery, float $timeTaken, ?Result $result, ?DriverException $exception): void
+	public function onQuery(string $sqlQuery, float $timeTaken, ?Result $result): void
 	{
 		foreach ($this->loggers as $logger) {
-			$logger->onQuery($sqlQuery, $timeTaken, $result, $exception);
+			$logger->onQuery($sqlQuery, $timeTaken, $result);
+		}
+	}
+
+
+	public function onQueryException(string $sqlQuery, float $timeTaken, ?DriverException $exception): void
+	{
+		foreach ($this->loggers as $logger) {
+			$logger->onQueryException($sqlQuery, $timeTaken, $exception);
 		}
 	}
 }
diff --git a/tests/cases/integration/exceptions.phpt b/tests/cases/integration/exceptions.phpt
@@ -7,11 +7,11 @@
 
 namespace NextrasTests\Dbal;
 
-use Nextras\Dbal\ConnectionException;
-use Nextras\Dbal\ForeignKeyConstraintViolationException;
-use Nextras\Dbal\NotNullConstraintViolationException;
-use Nextras\Dbal\QueryException;
-use Nextras\Dbal\UniqueConstraintViolationException;
+use Nextras\Dbal\Drivers\Exception\ConnectionException;
+use Nextras\Dbal\Drivers\Exception\ForeignKeyConstraintViolationException;
+use Nextras\Dbal\Drivers\Exception\NotNullConstraintViolationException;
+use Nextras\Dbal\Drivers\Exception\QueryException;
+use Nextras\Dbal\Drivers\Exception\UniqueConstraintViolationException;
 use Tester\Assert;
 
 require_once __DIR__ . '/../../bootstrap.php';

diff --git a/tests/cases/integration/transactions.phpt b/tests/cases/integration/transactions.phpt
@@ -105,11 +105,11 @@ class TransactionsTest extends IntegrationTestCase
 
 		$this->connection->rollbackTransaction();
 		$this->connection->rollbackTransaction();
-		Assert::same(0, $this->connection->getTransactionIndex());
+		Assert::same(0, $this->connection->getTransactionNestedIndex());
 
 		$this->connection->commitTransaction();
 		$this->connection->commitTransaction();
-		Assert::same(0, $this->connection->getTransactionIndex());
+		Assert::same(0, $this->connection->getTransactionNestedIndex());
 	}
 
 

diff --git a/tests/inc/TestLogger.php b/tests/inc/TestLogger.php
@@ -2,7 +2,7 @@
 
 namespace NextrasTests\Dbal;
 
-use Nextras\Dbal\DriverException;
+use Nextras\Dbal\Drivers\Exception\DriverException;
 use Nextras\Dbal\ILogger;
 use Nextras\Dbal\Result\Result;
 
@@ -28,10 +28,15 @@ public function onDisconnect(): void
 	}
 
 
-	public function onQuery(string $sqlQuery, float $timeTaken, ?Result $result, ?DriverException $exception): void
+	public function onQuery(string $sqlQuery, float $timeTaken, ?Result $result): void
 	{
 		if ($this->logQueries) {
-			$this->logged[] = [$sqlQuery, $timeTaken, $result, $exception];
+			$this->logged[] = [$sqlQuery, $timeTaken, $result];
 		}
 	}
+
+
+	public function onQueryException(string $sqlQuery, float $timeTaken, ?DriverException $exception): void
+	{
+	}
 }