/* * 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 { /// /// Abstract implementation of that provides a transactional context for database operations /// public abstract class TransactionalDbContext : DbContext, IAsyncDisposable, ITransactionalDbContext, IDbContextHandle { /// /// /// protected TransactionalDbContext() { } /// /// /// protected TransactionalDbContext(DbContextOptions options) : base(options) { } /// public IDbContextTransaction? Transaction { get; set; } /// public async Task OpenTransactionAsync(CancellationToken cancellationToken = default) { //open a new transaction on the current database this.Transaction = await base.Database.BeginTransactionAsync(cancellationToken); } /// public Task CommitTransactionAsync(CancellationToken token = default) { return Transaction != null ? Transaction.CommitAsync(token) : Task.CompletedTask; } /// public Task RollbackTransctionAsync(CancellationToken token = default) { return Transaction != null ? Transaction.RollbackAsync(token) : Task.CompletedTask; } /// IQueryable IDbContextHandle.Set() => base.Set(); /// void IDbContextHandle.Add(T entity) => base.Add(entity); /// void IDbContextHandle.Remove(T entity) => base.Remove(entity); /// public virtual void AddRange(IEnumerable entities) where T : class { DbSet set = base.Set(); set.AddRange(entities); } /// public virtual async Task 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; } /// public virtual void RemoveRange(IEnumerable entities) where T : class { DbSet set = base.Set(); set.RemoveRange(entities); } #pragma warning disable CA1816 // Dispose methods should call SuppressFinalize, ignore because base.Dispose() is called /// public sealed override void Dispose() { //dispose the transaction Transaction?.Dispose(); base.Dispose(); } /// 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 } }