Merge branch 'main' into keep-in-cache

Author: ilyakharev

CHANGELOG.md

@@ -1,4 +1,6 @@
 * fix keepInCache param in YdbQuery
+* add logger as Ydb config
+* added snapshot mode in noninteractive transaction
 
 ## 1.12.0
 * added StaticAuthentication

README.md

@@ -542,6 +542,23 @@ Methods of the query builder:
     - online
     - online_inconsistent
     - serializable
+    - snapshot
 - `txControl(\Ydb\Table\TransactionControl $tx_control)` - transaction control with custom settings
 
 You can chain these methods for convenience.
+
+## Logging
+
+For logging purposes, you need use class, which implements `\Psr\Log\LoggerInterface`.
+YDB-PHP-SDK has build-in loggers in `YdbPlatform\Ydb\Logger` namespace:
+* `NullLogger` - default
+* `SimpleStdLogger($level)` - logger, which push logs in STDERR. 
+
+Example of using:
+```php
+$config = [
+    'logger' => new \YdbPlatform\Ydb\Logger\SimpleStdLogger(\YdbPlatform\Ydb\Logger\SimpleStdLogger::INFO)
+]
+$ydb = new \YdbPlatform\Ydb\Ydb($config);
+```
+

src/Ydb.php

@@ -107,10 +107,14 @@ public function __construct($config = [], LoggerInterface $logger = null)
         $this->database = $config['database'] ?? null;
         $this->iam_config = $config['iam_config'] ?? [];
 
-        if ($logger){
-            $this->logger = $logger;
+        if (!is_null($logger) && isset($config['logger'])){
+            throw new \Exception('Logger set in 2 places');
+        } else if (isset($config['logger'])) {
+            $this->setLogger($config['logger']);
+        } else if ($logger) {
+            $this->setLogger($logger);
         } else {
-            $this->logger = new NullLogger();
+            $this->setLogger(new NullLogger());
         }
 
         $this->retry = new Retry($this->logger);
@@ -351,4 +355,21 @@ public function discoveryInterval()
     {
         return $this->discoveryInterval;
     }
+
+    /**
+     * @return LoggerInterface|NullLogger
+     */
+    public function getLogger()
+    {
+        return $this->logger;
+    }
+
+    /**
+     * @param LoggerInterface $logger
+     * @return void
+     */
+    protected function setLogger(LoggerInterface $logger){
+        $this->logger = $logger;
+    }
+
 }

src/YdbQuery.php

@@ -4,6 +4,7 @@
 
 use Ydb\Table\Query;
 use Ydb\Table\QueryCachePolicy;
+use Ydb\Table\SnapshotModeSettings;
 use Ydb\Table\StaleModeSettings;
 use Ydb\Table\OnlineModeSettings;
 use Ydb\Table\TransactionControl;
@@ -170,6 +171,11 @@ public function beginTx($mode)
                 ]);
                 break;
 
+            case 'snapshot':
+            case 'snapshot_read_only':
+                $tx_settings['snapshot_read_only'] = new SnapshotModeSettings;
+                break;
+
             case 'serializable':
             case 'serializable_read_write':
             default:

tests/CheckTxSettingsTest.php

@@ -0,0 +1,72 @@
+<?php
+
+namespace YdbPlatform\Ydb\Test;
+
+use PHPUnit\Framework\TestCase;
+use YdbPlatform\Ydb\Auth\Implement\AnonymousAuthentication;
+use YdbPlatform\Ydb\Logger\SimpleStdLogger;
+use YdbPlatform\Ydb\Ydb;
+
+class CheckTxSettingsTest extends TestCase
+{
+
+    /**
+     * @var Ydb
+     */
+    protected $ydb;
+    /**
+     * @var \YdbPlatform\Ydb\Table
+     */
+    protected $table;
+    /**
+     * @var \YdbPlatform\Ydb\Session|null
+     */
+    protected $session;
+
+    public function __construct(?string $name = null, array $data = [], $dataName = '')
+    {
+        parent::__construct($name, $data, $dataName);
+        $config = [
+
+            // Database path
+            'database'    => '/local',
+
+            // Database endpoint
+            'endpoint'    => 'localhost:2136',
+
+            // Auto discovery (dedicated server only)
+            'discovery'   => false,
+
+            // IAM config
+            'iam_config'  => [
+                'insecure' => true,
+            ],
+            'credentials' => new AnonymousAuthentication()
+        ];
+        $this->ydb = new Ydb($config, new SimpleStdLogger(SimpleStdLogger::DEBUG));
+        $this->table = $this->ydb->table();
+        $this->session = $this->table->session();
+    }
+
+    public function testSerializableTxConfig(){
+        $this->checkTx('serializable', 'serializable_read_write');
+    }
+
+    public function testSnapshotTxConfig(){
+        $this->checkTx('snapshot', 'snapshot_read_only');
+    }
+    public function testStaleTxConfig(){
+        $this->checkTx('stale', 'stale_read_only');
+    }
+    public function testOnlineTxConfig(){
+        $this->checkTx('online', 'online_read_only');
+    }
+
+    protected function checkTx(string $mode, string $value)
+    {
+        $query= $this->session->newQuery("SELECT 1;")
+            ->beginTx($mode);
+        self::assertEquals($value, $query->getRequestData()['tx_control']->getBeginTx()->getTxMode());
+        $query->execute();
+    }
+}

tests/LoggerCheckTest.php

@@ -0,0 +1,48 @@
+<?php
+
+namespace YdbPlatform\Ydb\Test;
+
+use PHPUnit\Framework\TestCase;
+use YdbPlatform\Ydb\Auth\Implement\AnonymousAuthentication;
+use YdbPlatform\Ydb\Logger\NullLogger;
+use YdbPlatform\Ydb\Logger\SimpleStdLogger;
+use YdbPlatform\Ydb\Ydb;
+
+class LoggerCheckTest extends TestCase{
+
+    public function testExceptExceptionInConfigs(){
+        $config = [
+            'logger' => new SimpleStdLogger(7)
+        ];
+        $this->expectException('Exception');
+        new Ydb($config, new NullLogger());
+    }
+    public function testCheckUseLoggerFromConfig(){
+        $logger = new SimpleStdLogger(7);
+        $config = [
+            'logger' => $logger
+        ];
+        $ydb = new Ydb($config);
+        $this->assertEquals($logger, $ydb->getLogger());
+    }
+    public function testCheckUseLoggerFromParam(){
+        $logger = new SimpleStdLogger(7);
+        $config = [];
+        $ydb = new Ydb($config, $logger);
+        $this->assertEquals($logger, $ydb->getLogger());
+    }
+    public function testCheckUseNullLogger(){
+        $config = [];
+        $ydb = new Ydb($config);
+        $this->assertInstanceOf(NullLogger::class, $ydb->getLogger());
+    }
+
+    public function testThrowExceptionOnNonLoggerObject(){
+        $config = [
+            'logger'    => new AnonymousAuthentication()
+        ];
+        $this->expectException('TypeError');
+        $ydb = new Ydb($config);
+        $this->assertInstanceOf(NullLogger::class, $ydb->getLogger());
+    }
+}