| | | 1 | | #pragma warning disable CA1873 |
| | | 2 | | |
| | | 3 | | using System; |
| | | 4 | | using System.Data.Common; |
| | | 5 | | using System.Linq; |
| | | 6 | | using System.Security.Cryptography; |
| | | 7 | | using System.Threading; |
| | | 8 | | using System.Threading.Tasks; |
| | | 9 | | using Microsoft.EntityFrameworkCore; |
| | | 10 | | using Microsoft.EntityFrameworkCore.Diagnostics; |
| | | 11 | | using Microsoft.Extensions.Logging; |
| | | 12 | | using Polly; |
| | | 13 | | |
| | | 14 | | namespace Jellyfin.Database.Implementations.Locking; |
| | | 15 | | |
| | | 16 | | /// <summary> |
| | | 17 | | /// Defines a locking mechanism that will retry any write operation for a few times. |
| | | 18 | | /// </summary> |
| | | 19 | | public class OptimisticLockBehavior : IEntityFrameworkCoreLockingBehavior |
| | | 20 | | { |
| | | 21 | | private readonly Policy _writePolicy; |
| | | 22 | | private readonly AsyncPolicy _writeAsyncPolicy; |
| | | 23 | | private readonly ILogger<OptimisticLockBehavior> _logger; |
| | | 24 | | |
| | | 25 | | /// <summary> |
| | | 26 | | /// Initializes a new instance of the <see cref="OptimisticLockBehavior"/> class. |
| | | 27 | | /// </summary> |
| | | 28 | | /// <param name="logger">The application logger.</param> |
| | | 29 | | public OptimisticLockBehavior(ILogger<OptimisticLockBehavior> logger) |
| | | 30 | | { |
| | 3 | 31 | | TimeSpan[] sleepDurations = [ |
| | 3 | 32 | | TimeSpan.FromMilliseconds(50), |
| | 3 | 33 | | TimeSpan.FromMilliseconds(50), |
| | 3 | 34 | | TimeSpan.FromMilliseconds(50), |
| | 3 | 35 | | TimeSpan.FromMilliseconds(50), |
| | 3 | 36 | | TimeSpan.FromMilliseconds(250), |
| | 3 | 37 | | TimeSpan.FromMilliseconds(250), |
| | 3 | 38 | | TimeSpan.FromMilliseconds(250), |
| | 3 | 39 | | TimeSpan.FromMilliseconds(150), |
| | 3 | 40 | | TimeSpan.FromMilliseconds(150), |
| | 3 | 41 | | TimeSpan.FromMilliseconds(150), |
| | 3 | 42 | | TimeSpan.FromMilliseconds(500), |
| | 3 | 43 | | TimeSpan.FromMilliseconds(150), |
| | 3 | 44 | | TimeSpan.FromMilliseconds(500), |
| | 3 | 45 | | TimeSpan.FromMilliseconds(150), |
| | 3 | 46 | | TimeSpan.FromSeconds(3) |
| | 3 | 47 | | ]; |
| | | 48 | | |
| | 3 | 49 | | Func<int, Context, TimeSpan> backoffProvider = (retryNo, context) => |
| | 3 | 50 | | { |
| | 3 | 51 | | var backoff = sleepDurations[retryNo - 1]; |
| | 3 | 52 | | return backoff + TimeSpan.FromMilliseconds(RandomNumberGenerator.GetInt32(0, (int)(backoff.TotalMilliseconds |
| | 3 | 53 | | }; |
| | | 54 | | |
| | 3 | 55 | | _logger = logger; |
| | 3 | 56 | | _writePolicy = Policy |
| | 3 | 57 | | .HandleInner<Exception>(e => |
| | 3 | 58 | | e.Message.Contains("database is locked", StringComparison.InvariantCultureIgnoreCase) || |
| | 3 | 59 | | e.Message.Contains("database table is locked", StringComparison.InvariantCultureIgnoreCase)) |
| | 3 | 60 | | .WaitAndRetry(sleepDurations.Length, backoffProvider, RetryHandle); |
| | 3 | 61 | | _writeAsyncPolicy = Policy |
| | 3 | 62 | | .HandleInner<Exception>(e => |
| | 3 | 63 | | e.Message.Contains("database is locked", StringComparison.InvariantCultureIgnoreCase) || |
| | 3 | 64 | | e.Message.Contains("database table is locked", StringComparison.InvariantCultureIgnoreCase)) |
| | 3 | 65 | | .WaitAndRetryAsync(sleepDurations.Length, backoffProvider, RetryHandle); |
| | | 66 | | |
| | | 67 | | void RetryHandle(Exception exception, TimeSpan timespan, int retryNo, Context context) |
| | | 68 | | { |
| | | 69 | | if (retryNo < sleepDurations.Length) |
| | | 70 | | { |
| | | 71 | | _logger.LogWarning("Operation failed retry {RetryNo}", retryNo); |
| | | 72 | | } |
| | | 73 | | else |
| | | 74 | | { |
| | | 75 | | _logger.LogError(exception, "Operation failed retry {RetryNo}", retryNo); |
| | | 76 | | } |
| | | 77 | | } |
| | 3 | 78 | | } |
| | | 79 | | |
| | | 80 | | /// <inheritdoc/> |
| | | 81 | | public void Initialise(DbContextOptionsBuilder optionsBuilder) |
| | | 82 | | { |
| | 0 | 83 | | _logger.LogInformation("The database locking mode has been set to: Optimistic."); |
| | 0 | 84 | | optionsBuilder.AddInterceptors(new RetryInterceptor(_writeAsyncPolicy, _writePolicy)); |
| | 0 | 85 | | optionsBuilder.AddInterceptors(new TransactionLockingInterceptor(_writeAsyncPolicy, _writePolicy)); |
| | 0 | 86 | | } |
| | | 87 | | |
| | | 88 | | /// <inheritdoc/> |
| | | 89 | | public void OnSaveChanges(JellyfinDbContext context, Action saveChanges) |
| | | 90 | | { |
| | 2 | 91 | | _writePolicy.Execute(saveChanges); |
| | 1 | 92 | | } |
| | | 93 | | |
| | | 94 | | /// <inheritdoc/> |
| | | 95 | | public async Task OnSaveChangesAsync(JellyfinDbContext context, Func<Task> saveChanges) |
| | | 96 | | { |
| | 1 | 97 | | await _writeAsyncPolicy.ExecuteAsync(saveChanges).ConfigureAwait(false); |
| | 0 | 98 | | } |
| | | 99 | | |
| | | 100 | | private sealed class TransactionLockingInterceptor : DbTransactionInterceptor |
| | | 101 | | { |
| | | 102 | | private readonly AsyncPolicy _asyncRetryPolicy; |
| | | 103 | | private readonly Policy _retryPolicy; |
| | | 104 | | |
| | 0 | 105 | | public TransactionLockingInterceptor(AsyncPolicy asyncRetryPolicy, Policy retryPolicy) |
| | | 106 | | { |
| | 0 | 107 | | _asyncRetryPolicy = asyncRetryPolicy; |
| | 0 | 108 | | _retryPolicy = retryPolicy; |
| | 0 | 109 | | } |
| | | 110 | | |
| | | 111 | | public override InterceptionResult<DbTransaction> TransactionStarting(DbConnection connection, TransactionStarti |
| | | 112 | | { |
| | 0 | 113 | | return InterceptionResult<DbTransaction>.SuppressWithResult(_retryPolicy.Execute(() => connection.BeginTrans |
| | | 114 | | } |
| | | 115 | | |
| | | 116 | | public override async ValueTask<InterceptionResult<DbTransaction>> TransactionStartingAsync(DbConnection connect |
| | | 117 | | { |
| | 0 | 118 | | return InterceptionResult<DbTransaction>.SuppressWithResult(await _asyncRetryPolicy.ExecuteAsync(async () => |
| | 0 | 119 | | } |
| | | 120 | | } |
| | | 121 | | |
| | | 122 | | private sealed class RetryInterceptor : DbCommandInterceptor |
| | | 123 | | { |
| | | 124 | | private readonly AsyncPolicy _asyncRetryPolicy; |
| | | 125 | | private readonly Policy _retryPolicy; |
| | | 126 | | |
| | 0 | 127 | | public RetryInterceptor(AsyncPolicy asyncRetryPolicy, Policy retryPolicy) |
| | | 128 | | { |
| | 0 | 129 | | _asyncRetryPolicy = asyncRetryPolicy; |
| | 0 | 130 | | _retryPolicy = retryPolicy; |
| | 0 | 131 | | } |
| | | 132 | | |
| | | 133 | | public override InterceptionResult<int> NonQueryExecuting(DbCommand command, CommandEventData eventData, Interce |
| | | 134 | | { |
| | 0 | 135 | | return InterceptionResult<int>.SuppressWithResult(_retryPolicy.Execute(command.ExecuteNonQuery)); |
| | | 136 | | } |
| | | 137 | | |
| | | 138 | | public override async ValueTask<InterceptionResult<int>> NonQueryExecutingAsync(DbCommand command, CommandEventD |
| | | 139 | | { |
| | 0 | 140 | | return InterceptionResult<int>.SuppressWithResult(await _asyncRetryPolicy.ExecuteAsync(async () => await com |
| | 0 | 141 | | } |
| | | 142 | | |
| | | 143 | | public override InterceptionResult<object> ScalarExecuting(DbCommand command, CommandEventData eventData, Interc |
| | | 144 | | { |
| | 0 | 145 | | return InterceptionResult<object>.SuppressWithResult(_retryPolicy.Execute(() => command.ExecuteScalar()!)); |
| | | 146 | | } |
| | | 147 | | |
| | | 148 | | public override async ValueTask<InterceptionResult<object>> ScalarExecutingAsync(DbCommand command, CommandEvent |
| | | 149 | | { |
| | 0 | 150 | | return InterceptionResult<object>.SuppressWithResult((await _asyncRetryPolicy.ExecuteAsync(async () => await |
| | 0 | 151 | | } |
| | | 152 | | |
| | | 153 | | public override InterceptionResult<DbDataReader> ReaderExecuting(DbCommand command, CommandEventData eventData, |
| | | 154 | | { |
| | 0 | 155 | | return InterceptionResult<DbDataReader>.SuppressWithResult(_retryPolicy.Execute(command.ExecuteReader)); |
| | | 156 | | } |
| | | 157 | | |
| | | 158 | | public override async ValueTask<InterceptionResult<DbDataReader>> ReaderExecutingAsync(DbCommand command, Comman |
| | | 159 | | { |
| | 0 | 160 | | return InterceptionResult<DbDataReader>.SuppressWithResult(await _asyncRetryPolicy.ExecuteAsync(async () => |
| | 0 | 161 | | } |
| | | 162 | | } |
| | | 163 | | } |