Merge pull request #62 from simPod/loggers

Add support for sync query logging
simPod · Sep 22, 2020 · 17ad379 · 17ad379
2 parents c6a2322 + cb058bb
commit 17ad379
Show file tree

Hide file tree

Showing 8 changed files with 133 additions and 10 deletions.
diff --git a/src/Client/PsrClickHouseAsyncClient.php b/src/Client/PsrClickHouseAsyncClient.php
@@ -105,7 +105,6 @@ private function executeRequest(
         $promise = promise_for($this->asyncClient->sendAsyncRequest($request));
 
         return $promise->then(
-            /** @return mixed */
             static function (ResponseInterface $response) use ($processResponse) {
                 if ($response->getStatusCode() !== 200) {
                     throw ServerError::fromResponse($response);

diff --git a/src/Client/PsrClickHouseClient.php b/src/Client/PsrClickHouseClient.php
@@ -7,12 +7,12 @@
 use DateTimeZone;
 use Psr\Http\Client\ClientInterface;
 use Psr\Http\Message\ResponseInterface;
-use Psr\Log\LoggerInterface;
 use SimPod\ClickHouseClient\Client\Http\RequestFactory;
 use SimPod\ClickHouseClient\Client\Http\RequestOptions;
 use SimPod\ClickHouseClient\Exception\CannotInsert;
 use SimPod\ClickHouseClient\Exception\ServerError;
 use SimPod\ClickHouseClient\Format\Format;
+use SimPod\ClickHouseClient\Logger\SqlLogger;
 use SimPod\ClickHouseClient\Output\Output;
 use SimPod\ClickHouseClient\Sql\Escaper;
 use SimPod\ClickHouseClient\Sql\SqlFactory;
@@ -31,7 +31,7 @@ class PsrClickHouseClient implements ClickHouseClient
 
     private RequestFactory $requestFactory;
 
-    private LoggerInterface $logger;
+    private SqlLogger $logger;
 
     private string $endpoint;
 
@@ -46,7 +46,7 @@ class PsrClickHouseClient implements ClickHouseClient
     public function __construct(
         ClientInterface $client,
         RequestFactory $requestFactory,
-        LoggerInterface $logger,
+        SqlLogger $logger,
         string $endpoint,
         array $defaultParameters = [],
         ?DateTimeZone $clickHouseTimeZone = null
@@ -162,8 +162,6 @@ public function insertWithFormat(string $table, Format $inputFormat, string $dat
     /** @param array<string, float|int|string> $requestParameters */
     private function executeRequest(string $sql, array $requestParameters = []) : ResponseInterface
     {
-        $this->logger->debug($sql, $requestParameters);
-
         $request = $this->requestFactory->prepareRequest(
             $this->endpoint,
             new RequestOptions(
@@ -173,7 +171,12 @@ private function executeRequest(string $sql, array $requestParameters = []) : Re
             )
         );
 
+        $this->logger->startQuery($sql);
+
         $response = $this->client->sendRequest($request);
+
+        $this->logger->stopQuery();
+
         if ($response->getStatusCode() !== 200) {
             throw ServerError::fromResponse($response);
         }

diff --git a/src/Logger/LoggerChain.php b/src/Logger/LoggerChain.php
@@ -0,0 +1,32 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SimPod\ClickHouseClient\Logger;
+
+final class LoggerChain implements SqlLogger
+{
+    /** @var SqlLogger[] */
+    private array $loggers;
+
+    /** @param SqlLogger[] $loggers */
+    public function __construct(array $loggers = [])
+    {
+        $this->loggers = $loggers;
+    }
+
+    /** @inheritdoc */
+    public function startQuery(string $sql, array $params = []) : void
+    {
+        foreach ($this->loggers as $logger) {
+            $logger->startQuery($sql, $params);
+        }
+    }
+
+    public function stopQuery() : void
+    {
+        foreach ($this->loggers as $logger) {
+            $logger->stopQuery();
+        }
+    }
+}
diff --git a/src/Logger/PsrLogger.php b/src/Logger/PsrLogger.php
@@ -0,0 +1,27 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SimPod\ClickHouseClient\Logger;
+
+use Psr\Log\LoggerInterface;
+
+final class PsrLogger implements SqlLogger
+{
+    private LoggerInterface $logger;
+
+    public function __construct(LoggerInterface $logger)
+    {
+        $this->logger = $logger;
+    }
+
+    /** @inheritdoc */
+    public function startQuery(string $sql, array $params = []) : void
+    {
+        $this->logger->debug($sql, $params);
+    }
+
+    public function stopQuery() : void
+    {
+    }
+}
diff --git a/src/Logger/SqlLogger.php b/src/Logger/SqlLogger.php
@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SimPod\ClickHouseClient\Logger;
+
+interface SqlLogger
+{
+    /** @param array<string, mixed> $params */
+    public function startQuery(string $sql, array $params = []) : void;
+
+    public function stopQuery() : void;
+}
diff --git a/tests/Logger/LoggerChainTest.php b/tests/Logger/LoggerChainTest.php
@@ -0,0 +1,49 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SimPod\ClickHouseClient\Tests\Logger;
+
+use PHPUnit\Framework\TestCase;
+use SimPod\ClickHouseClient\Logger\LoggerChain;
+use SimPod\ClickHouseClient\Logger\SqlLogger;
+
+final class LoggerChainTest extends TestCase
+{
+    public function testLog() : void
+    {
+        $logger = new class implements SqlLogger {
+            public ?string $sql = null;
+
+            /** @var array<string, mixed>|null $params */
+            public ?array $params = null;
+
+            public bool $started = false;
+
+            public bool $stopped = false;
+
+            /** @inheritDoc */
+            public function startQuery(string $sql, array $params = []) : void
+            {
+                $this->sql     = $sql;
+                $this->params  = $params;
+                $this->started = true;
+            }
+
+            public function stopQuery() : void
+            {
+                $this->stopped = true;
+            }
+        };
+
+        $chain = new LoggerChain([$logger]);
+
+        $chain->startQuery('sql', []);
+        $chain->stopQuery();
+
+        self::assertSame('sql', $logger->sql);
+        self::assertSame([], $logger->params);
+        self::assertTrue($logger->started);
+        self::assertTrue($logger->stopped);
+    }
+}
diff --git a/tests/Snippet/VersionTest.php b/tests/Snippet/VersionTest.php
@@ -15,6 +15,6 @@ final class VersionTest extends TestCaseBase
 
     public function testRun() : void
     {
-        self::assertRegExp('~(\d+\.)+\d+~', Version::run($this->client));
+        self::assertMatchesRegularExpression('~(\d+\.)+\d+~', Version::run($this->client));
     }
 }
diff --git a/tests/WithClient.php b/tests/WithClient.php
@@ -6,13 +6,13 @@
 
 use Http\Client\Curl\Client;
 use Nyholm\Psr7\Factory\Psr17Factory;
-use Psr\Log\NullLogger;
 use Psr\Log\Test\TestLogger;
 use SimPod\ClickHouseClient\Client\ClickHouseAsyncClient;
 use SimPod\ClickHouseClient\Client\ClickHouseClient;
 use SimPod\ClickHouseClient\Client\Http\RequestFactory;
 use SimPod\ClickHouseClient\Client\PsrClickHouseAsyncClient;
 use SimPod\ClickHouseClient\Client\PsrClickHouseClient;
+use SimPod\ClickHouseClient\Logger\PsrLogger;
 
 use function assert;
 use function getenv;
@@ -64,7 +64,7 @@ public function restartClickHouseClient() : void
                 new Psr17Factory(),
                 new Psr17Factory()
             ),
-            new NullLogger(),
+            new PsrLogger(new TestLogger()),
             $endpoint,
             $defaultParameters
         );
@@ -78,7 +78,7 @@ public function restartClickHouseClient() : void
                 new Psr17Factory(),
                 new Psr17Factory()
             ),
-            new TestLogger(),
+            new PsrLogger(new TestLogger()),
             $endpoint,
             $defaultParameters
         );