aboutsummaryrefslogtreecommitdiff
path: root/lib/VNLib.Plugins.Extensions.Data/src/TransactionalDbContext.cs
blob: cbb97992439689dd1ca775a15eecfd28d6dcce90 (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
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
/*
* Copyright (c) 2023 Vaughn Nugent
* 
* Library: VNLib
* Package: VNLib.Plugins.Extensions.Data
* File: TransactionalDbContext.cs 
*
* TransactionalDbContext.cs is part of VNLib.Plugins.Extensions.Data which is part of the larger 
* VNLib collection of libraries and utilities.
*
* VNLib.Plugins.Extensions.Data 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.
*
* VNLib.Plugins.Extensions.Data 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 https://www.gnu.org/licenses/.
*/

using System;
using System.Linq;
using System.Threading;
using System.Threading.Tasks;
using System.Collections.Generic;

using Microsoft.EntityFrameworkCore;
using Microsoft.EntityFrameworkCore.Storage;

using VNLib.Utils;
using VNLib.Plugins.Extensions.Data.Abstractions;


namespace VNLib.Plugins.Extensions.Data
{
    /// <summary>
    /// Abstract implementation of <see cref="ITransactionalDbContext"/> that provides a transactional context for database operations
    /// </summary>
    public abstract class TransactionalDbContext : DbContext, IAsyncDisposable, ITransactionalDbContext, IDbContextHandle
    {
        /// <summary>
        /// <inheritdoc/>
        /// </summary>
        protected TransactionalDbContext()
        { }

        /// <summary>
        /// <inheritdoc/>
        /// </summary>
        protected TransactionalDbContext(DbContextOptions options) : base(options)
        { }

        ///<inheritdoc/>
        public IDbContextTransaction? Transaction { get; set; }

        ///<inheritdoc/>
        public async Task OpenTransactionAsync(CancellationToken cancellationToken = default)
        {
            //open a new transaction on the current database
            this.Transaction = await base.Database.BeginTransactionAsync(cancellationToken);
        }

        ///<inheritdoc/>
        public Task CommitTransactionAsync(CancellationToken token = default)
        {
            return Transaction != null ? Transaction.CommitAsync(token) : Task.CompletedTask;
        }

        ///<inheritdoc/>
        public Task RollbackTransctionAsync(CancellationToken token = default)
        {
            return Transaction != null ? Transaction.RollbackAsync(token) : Task.CompletedTask;
        }

        ///<inheritdoc/>
        IQueryable<T> IDbContextHandle.Set<T>() => base.Set<T>();

        ///<inheritdoc/>
        void IDbContextHandle.Add<T>(T entity) => base.Add(entity);

        ///<inheritdoc/>
        void IDbContextHandle.Remove<T>(T entity) => base.Remove<T>(entity);

        ///<inheritdoc/>
        public virtual void AddRange<T>(IEnumerable<T> entities) where T : class
        {
            DbSet<T> set = base.Set<T>();
            set.AddRange(entities);
        }

        ///<inheritdoc/>
        public virtual async Task<ERRNO> SaveAndCloseAsync(bool commit, CancellationToken cancellation = default)
        {
            //Save db changes
            ERRNO result = await base.SaveChangesAsync(cancellation);
            if (commit)
            {
                await CommitTransactionAsync(cancellation);
            }
            else
            {
                await RollbackTransctionAsync(cancellation);
            }
            return result;
        }

        ///<inheritdoc/>
        public virtual void RemoveRange<T>(IEnumerable<T> entities) where T : class
        {
            DbSet<T> set = base.Set<T>();
            set.RemoveRange(entities);
        }

#pragma warning disable CA1816 // Dispose methods should call SuppressFinalize, ignore because base.Dispose() is called
        ///<inheritdoc/>
        public sealed override void Dispose()
        {
            //dispose the transaction
            Transaction?.Dispose();
            base.Dispose();
        }

        ///<inheritdoc/>
        public override async ValueTask DisposeAsync()
        {
            //If transaction has been created, dispose the transaction
            if (Transaction != null)
            {
                await Transaction.DisposeAsync();
            }
            await base.DisposeAsync();
        }
#pragma warning restore CA1816 // Dispose methods should call SuppressFinalize
    }
}