Multi-Tenancy: Implement tenant per Database strategy

src/NHibernate.Test/Async/CacheTest/CacheFixture.cs

@@ -29,7 +29,7 @@ public async Task TestSimpleCacheAsync()
 
 		private CacheKey CreateCacheKey(string text)
 		{
-			return new CacheKey(text, NHibernateUtil.String, "Foo", null);
+			return new CacheKey(text, NHibernateUtil.String, "Foo", null, null);
 		}
 
 		public async Task DoTestCacheAsync(ICacheProvider cacheProvider, CancellationToken cancellationToken = default(CancellationToken))

src/NHibernate.Test/Async/ConnectionStringTest/NamedConnectionStringFixture.cs

@@ -26,9 +26,8 @@ public partial class MockConnectionProvider : ConnectionProvider
 		/// <summary>
 		/// Get an open <see cref="DbConnection"/>.
 		/// </summary>
-		/// <param name="cancellationToken">A cancellation token that can be used to cancel the work</param>
 		/// <returns>An open <see cref="DbConnection"/>.</returns>
-		public override Task<DbConnection> GetConnectionAsync(CancellationToken cancellationToken)
+		public override Task<DbConnection> GetConnectionAsync(string connectionString, CancellationToken cancellationToken)
 		{
 			throw new NotImplementedException();
 		}

src/NHibernate.Test/Async/DebugSessionFactory.cs

@@ -26,6 +26,7 @@
 using NHibernate.Id;
 using NHibernate.Impl;
 using NHibernate.Metadata;
+using NHibernate.MultiTenancy;
 using NHibernate.Persister.Collection;
 using NHibernate.Persister.Entity;
 using NHibernate.Proxy;

src/NHibernate.Test/Async/FilterTest/DynamicFilterTest.cs

@@ -45,7 +45,7 @@ public async Task SecondLevelCachedCollectionsFilteringAsync()
 			var persister = Sfi
 				.GetCollectionPersister(typeof(Salesperson).FullName + ".Orders");
 			var cacheKey =
-				new CacheKey(testData.steveId, persister.KeyType, persister.Role, Sfi);
+				new CacheKey(testData.steveId, persister.KeyType, persister.Role, Sfi, null);
 			CollectionCacheEntry cachedData;
 
 			using (var session = OpenSession())

src/NHibernate.Test/Async/MultiTenancy/DatabaseStrategyNoDbSpecificFixture.cs

@@ -0,0 +1,265 @@
+//------------------------------------------------------------------------------
+// <auto-generated>
+//     This code was generated by AsyncGenerator.
+//
+//     Changes to this file may cause incorrect behavior and will be lost if
+//     the code is regenerated.
+// </auto-generated>
+//------------------------------------------------------------------------------
+
+
+using System;
+using System.Data.Common;
+using System.Data.SqlClient;
+using System.IO;
+using System.Linq;
+using System.Runtime.Serialization.Formatters.Binary;
+using NHibernate.Cfg;
+using NHibernate.Cfg.MappingSchema;
+using NHibernate.Dialect;
+using NHibernate.Driver;
+using NHibernate.Engine;
+using NHibernate.Linq;
+using NHibernate.Mapping.ByCode;
+using NHibernate.MultiTenancy;
+using NHibernate.Util;
+using NUnit.Framework;
+
+namespace NHibernate.Test.MultiTenancy
+{
+	using System.Threading.Tasks;
+	[TestFixture]
+	public class DatabaseStrategyNoDbSpecificFixtureAsync : TestCaseMappingByCode
+	{
+		private Guid _id;
+
+		protected override void Configure(Configuration configuration)
+		{
+			configuration.DataBaseIntegration(
+				x =>
+				{
+					x.MultiTenancy = MultiTenancyStrategy.Database;
+					x.MultiTenancyConnectionProvider<TestMultiTenancyConnectionProvider>();
+				});
+			configuration.Properties[Cfg.Environment.GenerateStatistics] = "true";
+			base.Configure(configuration);
+		}
+
+		private static void ValidateSqlServerConnectionAppName(ISession s, string tenantId)
+		{
+			var builder = new SqlConnectionStringBuilder(s.Connection.ConnectionString);
+			Assert.That(builder.ApplicationName, Is.EqualTo(tenantId));
+		}
+
+		private static void ValidateSqlServerConnectionAppName(IStatelessSession s, string tenantId)
+		{
+			var builder = new SqlConnectionStringBuilder(s.Connection.ConnectionString);
+			Assert.That(builder.ApplicationName, Is.EqualTo(tenantId));
+		}
+
+		[Test]
+		public async Task SecondLevelCacheReusedForSameTenantAsync()
+		{
+			using (var sesTen1 = OpenTenantSession("tenant1"))
+			{
+				var entity = await (sesTen1.GetAsync<Entity>(_id));
+			}
+
+			Sfi.Statistics.Clear();
+			using (var sesTen2 = OpenTenantSession("tenant1"))
+			{
+				var entity = await (sesTen2.GetAsync<Entity>(_id));
+			}
+
+			Assert.That(Sfi.Statistics.PrepareStatementCount, Is.EqualTo(0));
+			Assert.That(Sfi.Statistics.SecondLevelCacheHitCount, Is.EqualTo(1));
+		}
+
+		[Test]
+		public async Task SecondLevelCacheSeparationPerTenantAsync()
+		{
+			using (var sesTen1 = OpenTenantSession("tenant1"))
+			{
+				var entity = await (sesTen1.GetAsync<Entity>(_id));
+			}
+
+			Sfi.Statistics.Clear();
+			using (var sesTen2 = OpenTenantSession("tenant2"))
+			{
+				var entity = await (sesTen2.GetAsync<Entity>(_id));
+			}
+
+			Assert.That(Sfi.Statistics.PrepareStatementCount, Is.EqualTo(1));
+			Assert.That(Sfi.Statistics.SecondLevelCacheHitCount, Is.EqualTo(0));
+		}
+
+		[Test]
+		public async Task QueryCacheReusedForSameTenantAsync()
+		{
+			using (var sesTen1 = OpenTenantSession("tenant1"))
+			{
+				var entity = await (sesTen1.Query<Entity>().WithOptions(x => x.SetCacheable(true)).Where(e => e.Id == _id).SingleOrDefaultAsync());
+			}
+
+			Sfi.Statistics.Clear();
+			using (var sesTen2 = OpenTenantSession("tenant1"))
+			{
+				var entity = await (sesTen2.Query<Entity>().WithOptions(x => x.SetCacheable(true)).Where(e => e.Id == _id).SingleOrDefaultAsync());
+			}
+
+			Assert.That(Sfi.Statistics.PrepareStatementCount, Is.EqualTo(0));
+			Assert.That(Sfi.Statistics.QueryCacheHitCount, Is.EqualTo(1));
+		}
+
+		[Test]
+		public async Task QueryCacheSeparationPerTenantAsync()
+		{
+			using (var sesTen1 = OpenTenantSession("tenant1"))
+			{
+				var entity = await (sesTen1.Query<Entity>().WithOptions(x => x.SetCacheable(true)).Where(e => e.Id == _id).SingleOrDefaultAsync());
+			}
+
+			Sfi.Statistics.Clear();
+			using (var sesTen2 = OpenTenantSession("tenant2"))
+			{
+				var entity = await (sesTen2.Query<Entity>().WithOptions(x => x.SetCacheable(true)).Where(e => e.Id == _id).SingleOrDefaultAsync());
+			}
+
+			Assert.That(Sfi.Statistics.PrepareStatementCount, Is.EqualTo(1));
+			Assert.That(Sfi.Statistics.QueryCacheHitCount, Is.EqualTo(0));
+		}
+
+		[Test]
+		public async Task TenantSessionIsSerializableAndCanBeReconnectedAsync()
+		{
+			ISession deserializedSession = null;
+			using (var sesTen1 = OpenTenantSession("tenant1"))
+			{
+				var entity = await (sesTen1.Query<Entity>().WithOptions(x => x.SetCacheable(true)).Where(e => e.Id == _id).SingleOrDefaultAsync());
+				sesTen1.Disconnect();
+				deserializedSession = SpoofSerialization(sesTen1);
+			}
+
+			Sfi.Statistics.Clear();
+			using (deserializedSession)
+			{
+				deserializedSession.Reconnect();
+
+				//Expect session cache hit
+				var entity = await (deserializedSession.GetAsync<Entity>(_id));
+				if (IsSqlServerDialect)
+					ValidateSqlServerConnectionAppName(deserializedSession, "tenant1");
+				deserializedSession.Clear();
+
+				//Expect second level cache hit
+				await (deserializedSession.GetAsync<Entity>(_id));
+				Assert.That(GetTenantId(deserializedSession), Is.EqualTo("tenant1"));
+			}
+
+			Assert.That(Sfi.Statistics.PrepareStatementCount, Is.EqualTo(0));
+			Assert.That(Sfi.Statistics.SecondLevelCacheHitCount, Is.EqualTo(1));
+		}
+
+		private static string GetTenantId(ISession session)
+		{
+			return session.GetSessionImplementation().GetTenantIdentifier();
+		}
+
+		private static string GetTenantId(IStatelessSession session)
+		{
+			return session.GetSessionImplementation().GetTenantIdentifier();
+		}
+
+		private T SpoofSerialization<T>(T session)
+		{
+			var formatter = new BinaryFormatter
+			{
+#if !NETFX
+				SurrogateSelector = new SerializationHelper.SurrogateSelector()
+#endif
+			};
+			var stream = new MemoryStream();
+			formatter.Serialize(stream, session);
+
+			stream.Position = 0;
+
+			return (T) formatter.Deserialize(stream);
+		}
+
+		private ISession OpenTenantSession(string tenantId)
+		{
+			return Sfi.WithOptions().Tenant(GetTenantConfig(tenantId)).OpenSession();
+		}
+
+		private IStatelessSession OpenTenantStatelessSession(string tenantId)
+		{
+			return Sfi.WithStatelessOptions().Tenant(GetTenantConfig(tenantId)).OpenStatelessSession();
+		}
+
+		private TenantConfiguration GetTenantConfig(string tenantId)
+		{
+			return new TestTenantConfiguration(tenantId, IsSqlServerDialect);
+		}
+
+		private bool IsSqlServerDialect => Sfi.Dialect is MsSql2000Dialect && !(Sfi.ConnectionProvider.Driver is OdbcDriver);
+
+		#region Test Setup
+
+		protected override HbmMapping GetMappings()
+		{
+			var mapper = new ModelMapper();
+
+			mapper.Class<Entity>(
+				rc =>
+				{
+					rc.Cache(m => m.Usage(CacheUsage.NonstrictReadWrite));
+					rc.Id(x => x.Id, m => m.Generator(Generators.GuidComb));
+					rc.Property(x => x.Name);
+				});
+
+			return mapper.CompileMappingForAllExplicitlyAddedEntities();
+		}
+
+		protected override DbConnection OpenConnectionForSchemaExport()
+		{
+			return Sfi.Settings.MultiTenancyConnectionProvider
+					.GetConnectionAccess(GetTenantConfig("defaultTenant"), Sfi).GetConnection();
+		}
+
+		protected override ISession OpenSession()
+		{
+			return OpenTenantSession("defaultTenant");
+		}
+
+		protected override void OnTearDown()
+		{
+			using (var session = OpenSession())
+			using (var transaction = session.BeginTransaction())
+			{
+				session.Delete("from System.Object");
+
+				session.Flush();
+				transaction.Commit();
+			}
+		}
+
+		protected override void OnSetUp()
+		{
+			using (var session = OpenSession())
+			using (var transaction = session.BeginTransaction())
+			{
+				var e1 = new Entity {Name = "Bob"};
+				session.Save(e1);
+
+				var e2 = new Entity {Name = "Sally"};
+				session.Save(e2);
+
+				session.Flush();
+				transaction.Commit();
+				_id = e1.Id;
+			}
+		}
+
+		#endregion Test Setup
+	}
+}

src/NHibernate.Test/CacheTest/CacheFixture.cs

@@ -18,7 +18,7 @@ public void TestSimpleCache()
 
 		private CacheKey CreateCacheKey(string text)
 		{
-			return new CacheKey(text, NHibernateUtil.String, "Foo", null);
+			return new CacheKey(text, NHibernateUtil.String, "Foo", null, null);
 		}
 
 		public void DoTestCache(ICacheProvider cacheProvider)

src/NHibernate.Test/CacheTest/QueryKeyFixture.cs

@@ -35,13 +35,13 @@ private void QueryKeyFilterDescLikeToCompare(out QueryKey qk, out QueryKey qk1,
 			f.SetParameter("pLike", "so%");
 			var fk =  new FilterKey(f);
 			ISet<FilterKey> fks = new HashSet<FilterKey> { fk };
-			qk = new QueryKey(Sfi, SqlAll, new QueryParameters(), fks, null);
+			qk = new QueryKey(Sfi, SqlAll, new QueryParameters(), fks, null, null);
 
 			var f1 = new FilterImpl(Sfi.GetFilterDefinition(filterName));
 			f1.SetParameter("pLike", sameValue ? "so%" : "%ing");
 			var fk1 = new FilterKey(f1);
 			fks = new HashSet<FilterKey> { fk1 };
-			qk1 = new QueryKey(Sfi, SqlAll, new QueryParameters(), fks, null);
+			qk1 = new QueryKey(Sfi, SqlAll, new QueryParameters(), fks, null, null);
 		}
 
 		private void QueryKeyFilterDescValueToCompare(out QueryKey qk, out QueryKey qk1, bool sameValue)
@@ -52,13 +52,13 @@ private void QueryKeyFilterDescValueToCompare(out QueryKey qk, out QueryKey qk1,
 			f.SetParameter("pDesc", "something").SetParameter("pValue", 10);
 			var fk = new FilterKey(f);
 			ISet<FilterKey> fks = new HashSet<FilterKey> { fk };
-			qk = new QueryKey(Sfi, SqlAll, new QueryParameters(), fks, null);
+			qk = new QueryKey(Sfi, SqlAll, new QueryParameters(), fks, null, null);
 
 			var f1 = new FilterImpl(Sfi.GetFilterDefinition(filterName));
 			f1.SetParameter("pDesc", "something").SetParameter("pValue", sameValue ? 10 : 11);
 			var fk1 = new FilterKey(f1);
 			fks = new HashSet<FilterKey> { fk1 };
-			qk1 = new QueryKey(Sfi, SqlAll, new QueryParameters(), fks, null);
+			qk1 = new QueryKey(Sfi, SqlAll, new QueryParameters(), fks, null, null);
 		}
 
 		[Test]
@@ -122,15 +122,15 @@ public void ToStringWithFilters()
 			f.SetParameter("pLike", "so%");
 			var fk = new FilterKey(f);
 			ISet<FilterKey> fks = new HashSet<FilterKey> { fk };
-			var qk = new QueryKey(Sfi, SqlAll, new QueryParameters(), fks, null);
+			var qk = new QueryKey(Sfi, SqlAll, new QueryParameters(), fks, null, null);
 			Assert.That(qk.ToString(), Does.Contain($"filters: ['{fk}']"), "Like");
 
 			filterName = "DescriptionEqualAndValueGT";
 			f = new FilterImpl(Sfi.GetFilterDefinition(filterName));
 			f.SetParameter("pDesc", "something").SetParameter("pValue", 10);
 			fk = new FilterKey(f);
 			fks = new HashSet<FilterKey> { fk };
-			qk = new QueryKey(Sfi, SqlAll, new QueryParameters(), fks, null);
+			qk = new QueryKey(Sfi, SqlAll, new QueryParameters(), fks, null, null);
 			Assert.That(qk.ToString(), Does.Contain($"filters: ['{fk}']"), "Value");
 		}
 
@@ -148,7 +148,7 @@ public void ToStringWithMoreFilters()
 			var fvk = new FilterKey(fv);
 
 			ISet<FilterKey> fks = new HashSet<FilterKey> { fk, fvk };
-			var qk = new QueryKey(Sfi, SqlAll, new QueryParameters(), fks, null);
+			var qk = new QueryKey(Sfi, SqlAll, new QueryParameters(), fks, null, null);
 			Assert.That(qk.ToString(), Does.Contain($"filters: ['{fk}', '{fvk}']"));
 		}
 	}