VNLib.Plugins.Extensions.Data/TransactionalDbContext.cs


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

using System;
using System.Threading;
using System.Threading.Tasks;
using Microsoft.EntityFrameworkCore;
using Microsoft.EntityFrameworkCore.Storage;

namespace VNLib.Plugins.Extensions.Data
{
    public abstract class TransactionalDbContext : DbContext, IAsyncDisposable, IDisposable
    {
        /// <summary>
        /// <inheritdoc/>
        /// </summary>
        protected TransactionalDbContext()
        {}
        /// <summary>
        /// <inheritdoc/>
        /// </summary>
        protected TransactionalDbContext(DbContextOptions options) : base(options)
        {}

        /// <summary>
        /// The transaction that was opened on the current context
        /// </summary>
        public IDbContextTransaction? Transaction { get; set; }
        ///<inheritdoc/>
        public override void Dispose()
        {
            //dispose the transaction
            this.Transaction?.Dispose();
            base.Dispose();
        }

        /// <summary>
        /// Opens a single transaction on the current context. If a transaction is already open, 
        /// it is disposed and a new transaction is begun.
        /// </summary>
        public async Task OpenTransactionAsync(CancellationToken cancellationToken = default)
        {
            //open a new transaction on the current database
            this.Transaction = await base.Database.BeginTransactionAsync(cancellationToken);
        }
        /// <summary>
        /// Invokes the <see cref="IDbContextTransaction.Commit"/> on the current context
        /// </summary>
        public Task CommitTransactionAsync(CancellationToken token = default)
        {
            return Transaction != null ? Transaction.CommitAsync(token) : Task.CompletedTask;
        }
        /// <summary>
        /// Invokes the <see cref="IDbContextTransaction.Rollback"/> on the current context
        /// </summary>
        public Task RollbackTransctionAsync(CancellationToken token = default)
        {
            return Transaction != null ? Transaction.RollbackAsync(token) : Task.CompletedTask;
        }
        ///<inheritdoc/>
        public override async ValueTask DisposeAsync()
        {
            //If transaction has been created, dispose the transaction
            if(this.Transaction != null)
            {
                await this.Transaction.DisposeAsync();
            }
            await base.DisposeAsync();
            GC.SuppressFinalize(this);
        }
    }
}