NH-3046 - Fix potential memory leak

Author: montagutcarlos

src/NHibernate.Test/NHSpecificTest/NH3046/Fixture.cs

@@ -0,0 +1,60 @@
+
+using System;
+using NUnit.Framework;
+using NHibernate.Mapping.ByCode;
+using NHibernate.Cfg;
+
+namespace NHibernate.Test.NHSpecificTest.NH3046
+{
+	[TestFixture]
+	public class Fixture : BugTestCase
+	{
+		[Test]
+		public void MemoryLeak()
+		{
+
+			long initialMemory = GC.GetTotalMemory(true);
+			long nextId = 1;
+			long nextIdChild = 1;
+
+			using (ISession session = OpenSession())
+			using (session.BeginTransaction())
+			{
+				// We try to insert 100.000 entities, cleaning the sessions
+				// every 1000.
+				// We keep track of memory, that should be increasing forever.
+				// We took a maximum of 250000 that can change to greater number but
+				// not increase forever.
+				for (int i = 0; i < 100; i++)
+				{
+					GC.Collect();
+					long currentMemory = GC.GetTotalMemory(true);
+					long memoryIncrease = currentMemory - initialMemory;
+
+					Assert.Less(memoryIncrease, 400000);
+					// Console.WriteLine(memoryIncrease);
+					for (int j = 0; j < 1000; j++)
+					{
+						Parent a = new Parent();
+						a.Id = nextId++;
+
+						Child c = new Child();
+						c.Id = nextIdChild++;
+
+						a.Childs.Add(c);
+
+						session.Save(c);
+						session.Save(a);
+					}
+					session.Flush();
+					session.Clear();
+				}
+			}
+		}
+
+		protected override string CacheConcurrencyStrategy
+		{
+			get { return null; }
+		}
+	}
+}

src/NHibernate.Test/NHSpecificTest/NH3046/Mappings.hbm.xml

@@ -0,0 +1,21 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<hibernate-mapping
+	xmlns="urn:nhibernate-mapping-2.2"
+	assembly="NHibernate.Test"
+	namespace="NHibernate.Test.NHSpecificTest.NH3046">
+
+  <class name="Parent">
+    <id name="Id"/>
+
+    <bag name="Childs" lazy="true" inverse="true" cascade="all">
+      <key column="parent_id" />
+      <one-to-many class="Child" />
+    </bag>
+
+  </class>
+
+  <class name="Child">
+    <id name="Id"/>
+  </class>
+
+</hibernate-mapping>

src/NHibernate.Test/NHSpecificTest/NH3046/Model.cs

@@ -0,0 +1,21 @@
+namespace NHibernate.Test.NHSpecificTest.NH3046
+{
+	using System;
+	using System.Collections.Generic;
+
+	public class Parent
+	{
+		public Parent()
+		{
+			Childs = new List<Child>();
+		}
+
+		public virtual long Id { get; set; }
+		public virtual IList<Child> Childs { get; set; }
+	}
+
+	public class Child
+	{
+		public virtual long Id { get; set; }
+	}
+}

src/NHibernate.Test/NHibernate.Test.csproj

@@ -726,6 +726,8 @@
     <Compile Include="NHSpecificTest\NH2931\Fixture.cs" />
     <Compile Include="NHSpecificTest\NH2931\Mappings.cs" />
     <Compile Include="NHSpecificTest\NH2931\Models.cs" />
+    <Compile Include="NHSpecificTest\NH3046\Fixture.cs" />
+    <Compile Include="NHSpecificTest\NH3046\Model.cs" />
     <Compile Include="NHSpecificTest\NH3518\ClassWithXmlMember.cs" />
     <Compile Include="NHSpecificTest\NH3518\XmlColumnTest.cs" />
     <Compile Include="NHSpecificTest\NH3609\MappingEntity.cs" />
@@ -3162,6 +3164,7 @@
     <EmbeddedResource Include="NHSpecificTest\NH1291AnonExample\Mappings.hbm.xml" />
   </ItemGroup>
   <ItemGroup>
+    <EmbeddedResource Include="NHSpecificTest\NH3046\Mappings.hbm.xml" />
     <EmbeddedResource Include="NHSpecificTest\NH3518\Mappings.hbm.xml" />
     <EmbeddedResource Include="NHSpecificTest\NH3609\Mappings.hbm.xml" />
     <EmbeddedResource Include="NHSpecificTest\NH3818\Mappings.hbm.xml" />

src/NHibernate/Action/CollectionAction.cs

@@ -114,16 +114,19 @@ public virtual BeforeTransactionCompletionProcessDelegate BeforeTransactionCompl
 
 		public virtual AfterTransactionCompletionProcessDelegate AfterTransactionCompletionProcess
 		{
+
 			get
 			{
-				return new AfterTransactionCompletionProcessDelegate((success) =>
+				// Only make sense to add the delegate if there is a cache.
+				if (persister.HasCache)
 				{
-					if (persister.HasCache)
+					return new AfterTransactionCompletionProcessDelegate((success) =>
 					{
-						CacheKey ck = Session.GenerateCacheKey(key, persister.KeyType, persister.Role);
+						CacheKey ck = new CacheKey(key, persister.KeyType, persister.Role, Session.EntityMode, Session.Factory);
 						persister.Cache.Release(ck, softLock);
-					}
-				});
+					});
+				}
+				return null; 
 			}
 		}
 

src/NHibernate/Action/CollectionUpdateAction.cs

@@ -125,10 +125,11 @@ public override AfterTransactionCompletionProcessDelegate AfterTransactionComple
 		{
 			get
 			{
-				return new AfterTransactionCompletionProcessDelegate((success) =>
+				// Only make sense to add the delegate if there is a cache.
+				if (Persister.HasCache)
 				{
 					// NH Different behavior: to support unlocking collections from the cache.(r3260)
-					if (Persister.HasCache)
+					return new AfterTransactionCompletionProcessDelegate((success) =>
 					{
 						CacheKey ck = Session.GenerateCacheKey(Key, Persister.KeyType, Persister.Role);
 
@@ -140,7 +141,7 @@ public override AfterTransactionCompletionProcessDelegate AfterTransactionComple
 							{
 								CollectionCacheEntry entry = new CollectionCacheEntry(Collection, Persister);
 								bool put = Persister.Cache.AfterUpdate(ck, entry, null, Lock);
-		
+
 								if (put && Session.Factory.Statistics.IsStatisticsEnabled)
 								{
 									Session.Factory.StatisticsImplementor.SecondLevelCachePut(Persister.Cache.RegionName);
@@ -151,8 +152,9 @@ public override AfterTransactionCompletionProcessDelegate AfterTransactionComple
 						{
 							Persister.Cache.Release(ck, Lock);
 						}
-					}
-				});
+					});
+				}
+				return null;
 			}
 		}
 	}

src/NHibernate/Action/EntityAction.cs

@@ -106,7 +106,9 @@ public virtual BeforeTransactionCompletionProcessDelegate BeforeTransactionCompl
 		{
 			get
 			{
-				return new BeforeTransactionCompletionProcessDelegate(BeforeTransactionCompletionProcessImpl);
+				return NeedsBeforeTransactionCompletion()
+					? new BeforeTransactionCompletionProcessDelegate(BeforeTransactionCompletionProcessImpl)
+					: null;
 			}
 		}
 
@@ -120,11 +122,18 @@ public virtual AfterTransactionCompletionProcessDelegate AfterTransactionComplet
 			}
 		}
 
-		private bool NeedsAfterTransactionCompletion()
+		protected virtual bool NeedsAfterTransactionCompletion()
 		{
 			return persister.HasCache || HasPostCommitEventListeners;
 		}
-		
+
+		protected virtual bool NeedsBeforeTransactionCompletion()
+		{
+			// At the moment, there is no need to add the delegate, 
+			// Subclasses can override this method and add the delegate if needed.
+			return false;
+		}
+
 		protected virtual void BeforeTransactionCompletionProcessImpl()
 		{
 		}