Merge pull request #108 from ydb-platform/lambda-on-exception

Add lambda on exception in retryTransaction

Author: ilyakharev

CHANGELOG.md

@@ -1,3 +1,5 @@
+* added lambda on exception in retryTransaction
+
 ## 1.10.0
 * changed level of update token log record from info to debug
 * created refresh token ratio parameter

src/Table.php

@@ -481,22 +481,45 @@ public function retrySession(Closure $userFunc, bool $idempotent = false, RetryP
 
     }
 
-    public function retryTransaction(Closure $userFunc, bool $idempotent = false, RetryParams $params = null){
-
-        return $this->retrySession(function (Session $session) use ($userFunc) {
-                try{
-                        $session->beginTransaction();
-                        $result = $userFunc($session);
-                        $session->commitTransaction();
-                        return $result;
-                } catch (Exception $exception){
-                    try {
-                        $session->rollbackTransaction();
-                    } catch (Exception $e){}
-                    throw $exception;
-                }
-            }, $idempotent, $params);
+    public function retryTransaction(Closure $userFunc, bool $idempotent = null, RetryParams $params = null, array $options){
+        if ($options == null) {
+            $options = [];
+        }
 
+        if (isset($options['idempotent']) && !is_null($idempotent)){
+            throw new \YdbPlatform\Ydb\Exception('Idempotent flag set in 2 params');
+        }
+        else if (!is_null($idempotent)) {
+            $options['idempotent'] = $idempotent;
+        } else {
+            $options['idempotent'] = false;
+        }
+
+        if (isset($options['retryParams']) && !is_null($params)){
+            throw new \YdbPlatform\Ydb\Exception('RetryParams set in 2 params');
+        }
+        else if (!isset($options['retryParams'])) {
+            $options['retryParams'] = $params;
+        }
+
+        if (!isset($options['callback_on_error'])) {
+            $options['callback_on_error'] = function (\Exception $exception) {};
+        }
+        return $this->retrySession(function (Session $session) use ($options, $userFunc) {
+            try {
+                $session->beginTransaction();
+                $result = $userFunc($session);
+                $session->commitTransaction();
+                return $result;
+            } catch (\Exception $exception) {
+                $options['callback_on_error']($exception);
+                try {
+                    $session->rollbackTransaction();
+                } catch (Exception $e) {
+                }
+                throw $exception;
+            }
+        }, $options['idempotent'], $options['retryParams']);
     }
 
     protected function deleteSession(string $exception): bool

tests/CheckParamsInRetryTransactionTest.php

@@ -0,0 +1,53 @@
+<?php
+
+namespace YdbPlatform\Ydb\Test;
+
+use PHPUnit\Framework\TestCase;
+use YdbPlatform\Ydb\Exception;
+use YdbPlatform\Ydb\Retry\RetryParams;
+use YdbPlatform\Ydb\Session;
+use YdbPlatform\Ydb\Ydb;
+use YdbPlatform\Ydb\YdbTable;
+
+class CheckParamsInRetryTransactionTest extends TestCase
+{
+    public function testRun()
+    {
+        $config = [
+
+            // Database path
+            'database' => '/local',
+
+            // Database endpoint
+            'endpoint' => 'localhost:2136',
+
+            // Auto discovery (dedicated server only)
+            'discovery' => false,
+
+            // IAM config
+            'iam_config' => [
+                'anonymous' => true,
+                'insecure' => true
+            ],
+        ];
+
+        $ydb = new Ydb($config);
+
+        $table = $ydb->table();
+
+        try {
+            $table->retryTransaction(function (Session $session){}, true, null, ['idempotent'=>true]);
+            throw new \Exception('retryTransaction does not throw exception');
+        } catch (\YdbPlatform\Ydb\Exception $e){
+            self::assertEquals(1,1);
+        }
+
+        try {
+            $table->retryTransaction(function (Session $session){}, null, new RetryParams(), ['retryParams'=>new RetryParams()]);
+            throw new \Exception('retryTransaction does not throw exception');
+        } catch (\YdbPlatform\Ydb\Exception $e){
+            self::assertEquals(1,1);
+        }
+
+    }
+}

tests/RetryOnExceptionTest.php

@@ -4,6 +4,7 @@
 
 use PHPUnit\Framework\TestCase;
 use YdbPlatform\Ydb\Auth\Implement\AnonymousAuthentication;
+use YdbPlatform\Ydb\Exceptions\Grpc\ResourceExhaustedException;
 use YdbPlatform\Ydb\Retry\RetryParams;
 use YdbPlatform\Ydb\Session;
 use YdbPlatform\Ydb\Table;
@@ -70,5 +71,15 @@ private function retryTest(Table $table)
                 $tres
             );
         }, true, new RetryParams(2000));
+        $i = 0;
+        $table->retryTransaction(function (Session $session) use (&$i) {
+            if($i == 0){
+                throw new ResourceExhaustedException('Test exception');
+            }
+            self::assertEquals(5, $i);
+        }, null, null, [
+            'idempotent' => true,
+            'callback_on_error' => function (\Exception $exception) use (&$i) {$i=5;}
+        ]);
     }
 }