Merge pull request #489 from TortugaResearch/IAsyncDisposable-488

Add IAsyncDisposable support #488

Tortuga.Chain/Changelog.md

@@ -57,6 +57,13 @@ datasource.FromTable<TObject>(filter).ToAggregate().ToCollection().Execute();
 
 In the second version, the table or view name is extracted from the class.
 
+### Technical Debt
+
+[#488 Add IAsyncDisposable support](https://github.com/TortugaResearch/Tortuga.Chain/issues/488)
+
+Added support for `IAsyncDisposable` to transactional data sources.
+
+
 ## Version 4.2
 
 ### Features

Tortuga.Chain/Shared/DataSource/TransactionalDataSourceTrait`5.cs

@@ -9,6 +9,9 @@ namespace Traits
 {
 	[Trait]
 	class TransactionalDataSourceTrait<TRootDataSource, TConnection, TTransaction, TCommand, TDatabaseMetadata> : ITransactionalDataSource, IDisposable
+#if NET6_0_OR_GREATER
+, IAsyncDisposable
+#endif
 		where TRootDataSource : class, IRootDataSource, IDataSource, IHasExtensionCache
 		where TConnection : DbConnection
 		where TTransaction : DbTransaction
@@ -197,6 +200,36 @@ public void Dispose(bool disposing)
 			}
 		}
 
+#if NET6_0_OR_GREATER
+		/// <summary>
+		/// Closes the current transaction and connection. If not committed, the transaction is rolled back.
+		/// </summary>
+		[Expose]
+		public ValueTask DisposeAsync()
+		{
+			return DisposeAsync(true);
+		}
+
+		/// <summary>
+		/// Closes the current transaction and connection. If not committed, the transaction is rolled back.
+		/// </summary>
+		/// <param name="disposing"></param>
+		[Expose(Accessibility = Accessibility.Protected, Inheritance = Inheritance.Virtual)]
+		public async ValueTask DisposeAsync(bool disposing)
+		{
+			if (m_Disposed)
+				return;
+
+			if (disposing)
+			{
+				await m_Transaction.DisposeAsync().ConfigureAwait(false);
+				await m_Connection.DisposeAsync().ConfigureAwait(false);
+				DisposableContainer?.OnDispose();
+				m_Disposed = true;
+			}
+		}
+#endif
+
 		/// <summary>
 		/// The extension cache is used by extensions to store data source specific information.
 		/// </summary>
@@ -261,4 +294,4 @@ public TDatabaseMetadata DatabaseMetadata
 			get { return (TDatabaseMetadata)m_BaseDataSource.DatabaseMetadata; }
 		}
 	}
-}
+}

Tortuga.Chain/Shared/Tests/Core/DataSourceTest.cs

@@ -1,4 +1,5 @@
-
+using Tortuga.Chain.DataSources;
+
 namespace Tests.Core;
 
 [TestClass]
@@ -31,4 +32,54 @@ public async Task TestConnectionAsync(string dataSourceName, DataSourceType mode
 			Release(dataSource);
 		}
 	}
-}
+
+	[DataTestMethod, RootData(DataSourceGroup.Primary)]
+	public void Transaction_Dispose(string dataSourceName)
+	{
+		var dataSource = DataSource(dataSourceName);
+		try
+		{
+			dataSource.TestConnection();
+			var trans = ((IRootDataSource)dataSource).BeginTransaction();
+			trans.Dispose();
+		}
+		finally
+		{
+			Release(dataSource);
+		}
+	}
+
+#if NET6_0_OR_GREATER
+
+	[DataTestMethod, RootData(DataSourceGroup.Primary)]
+	public async Task Transaction_DisposeAsync_Using(string dataSourceName)
+	{
+		var dataSource = DataSource(dataSourceName);
+		try
+		{
+			dataSource.TestConnection();
+			await using var trans = await ((IRootDataSource)dataSource).BeginTransactionAsync();
+		}
+		finally
+		{
+			Release(dataSource);
+		}
+	}
+
+	[DataTestMethod, RootData(DataSourceGroup.Primary)]
+	public async Task Transaction_DisposeAsync(string dataSourceName)
+	{
+		var dataSource = DataSource(dataSourceName);
+		try
+		{
+			dataSource.TestConnection();
+			var trans = await ((IRootDataSource)dataSource).BeginTransactionAsync();
+			await trans.DisposeAsync().ConfigureAwait(false);
+		}
+		finally
+		{
+			Release(dataSource);
+		}
+	}
+#endif
+}

Tortuga.Chain/Tortuga.Chain.Core/DataSources/IRootDataSource.cs

@@ -56,4 +56,4 @@ public interface IRootDataSource
 	/// <param name="transaction">The transaction to wrap.</param>
 	/// <returns></returns>
 	IOpenDataSource CreateOpenDataSource(IDbConnection connection, IDbTransaction? transaction = null);
-}
+}

Tortuga.Chain/Tortuga.Chain.Core/DataSources/ITransactionalDataSource.cs

@@ -6,10 +6,14 @@ namespace Tortuga.Chain.DataSources;
 /// <remarks>
 /// This interface is primarily for testing purposes.
 /// </remarks>
-public interface ITransactionalDataSource : IOpenDataSource
+public interface ITransactionalDataSource : IOpenDataSource, IDisposable
+#if NET6_0_OR_GREATER
+, IAsyncDisposable
+#endif
+
 {
 	/// <summary>
 	/// Commits this transaction.
 	/// </summary>
 	void Commit();
-}
+}