blob: 56daef1d62aac2623bea4ac5d42fd6e28be2bcf2 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
|
<?php
declare(strict_types=1);
/*
* @copyright 2022 Christoph Wurst <christoph@winzerhof-wurst.at>
*
* @author 2022 Christoph Wurst <christoph@winzerhof-wurst.at>
*
* @license GNU AGPL version 3 or any later version
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
namespace OCP\AppFramework\Db;
use OC\DB\Exceptions\DbalException;
use OCP\DB\Exception;
use OCP\IDBConnection;
use Throwable;
use function OCP\Log\logger;
/**
* Helper trait for transactional operations
*
* @since 24.0.0
*/
trait TTransactional {
/**
* Run an atomic database operation
*
* - Commit if no exceptions are thrown, return the callable result
* - Revert otherwise and rethrows the exception
*
* @template T
* @param callable $fn
* @psalm-param callable():T $fn
* @param IDBConnection $db
*
* @return mixed the result of the passed callable
* @psalm-return T
*
* @throws Exception for possible errors of commit or rollback or the custom operations within the closure
* @throws Throwable any other error caused by the closure
*
* @since 24.0.0
* @see https://docs.nextcloud.com/server/latest/developer_manual/basics/storage/database.html#transactions
*/
protected function atomic(callable $fn, IDBConnection $db) {
$db->beginTransaction();
try {
$result = $fn();
$db->commit();
return $result;
} catch (Throwable $e) {
$db->rollBack();
throw $e;
}
}
/**
* Wrapper around atomic() to retry after a retryable exception occurred
*
* Certain transactions might need to be retried. This is especially useful
* in highly concurrent requests where a deadlocks is thrown by the database
* without waiting for the lock to be freed (e.g. due to MySQL/MariaDB deadlock
* detection)
*
* @template T
* @param callable $fn
* @psalm-param callable():T $fn
* @param IDBConnection $db
* @param int $maxRetries
*
* @return mixed the result of the passed callable
* @psalm-return T
*
* @throws Exception for possible errors of commit or rollback or the custom operations within the closure
* @throws Throwable any other error caused by the closure
*
* @since 27.0.0
*/
protected function atomicRetry(callable $fn, IDBConnection $db, int $maxRetries = 3): mixed {
for ($i = 0; $i < $maxRetries; $i++) {
try {
return $this->atomic($fn, $db);
} catch (DbalException $e) {
if (!$e->isRetryable() || $i === ($maxRetries - 1)) {
throw $e;
}
logger('core')->warning('Retrying operation after retryable exception.', [ 'exception' => $e ]);
}
}
}
}
|
