NH-1752 - Cease silently nullifying dates before 1753

Obsolete base date parameterization and set its default value to MinDate

Author: fredericDelaporte

src/NHibernate.Test/Async/NHSpecificTest/Logs/LogsFixture.cs

@@ -51,7 +51,7 @@ public async Task WillGetSessionIdFromSessionLogsAsync()
 
 				await (s.GetAsync<Person>(1));//will execute some sql
 
-				var loggingEvent = spy.Events[0];
+				var loggingEvent = spy.GetWholeLog();
 				Assert.That(loggingEvent.Contains(sessionId.ToString()), Is.True);
 			}
 		}
@@ -89,12 +89,9 @@ public TextLogSpy(string loggerName, string pattern)
 				loggerImpl.Level = Level.All;
 			}
 
-			public string[] Events
+			public string GetWholeLog()
 			{
-				get
-				{
-					return stringBuilder.ToString().Split(new[] {Environment.NewLine}, StringSplitOptions.RemoveEmptyEntries);
-				}
+				return stringBuilder.ToString();
 			}
 
 			public void Dispose()

src/NHibernate.Test/Async/TypesTest/DateTypeTest.cs

@@ -0,0 +1,78 @@
+//------------------------------------------------------------------------------
+// <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.Collections.Generic;
+using NHibernate.Dialect;
+using NHibernate.Type;
+using NUnit.Framework;
+using System;
+
+namespace NHibernate.Test.TypesTest
+{
+	using System.Threading.Tasks;
+	using System.Threading;
+
+	[TestFixture]
+	public class DateTypeFixtureAsync : TypeFixtureBase
+	{
+		protected override string TypeName
+		{
+			get { return "Date"; }
+		}
+
+		[Test]
+		public Task ReadWriteNormalAsync()
+		{
+			try
+			{
+				var expected = DateTime.Today.Date;
+
+				return ReadWriteAsync(expected);
+			}
+			catch (Exception ex)
+			{
+				return Task.FromException<object>(ex);
+			}
+		}
+
+		[Test]
+		public Task ReadWriteMinAsync()
+		{
+			try
+			{
+				var expected = Sfi.ConnectionProvider.Driver.MinDate;
+
+				return ReadWriteAsync(expected);
+			}
+			catch (Exception ex)
+			{
+				return Task.FromException<object>(ex);
+			}
+		}
+
+		private async Task ReadWriteAsync(DateTime expected, CancellationToken cancellationToken = default(CancellationToken))
+		{
+			var basic = new DateClass { DateValue = expected.AddHours(1) };
+			object savedId;
+			using (var s = OpenSession())
+			{
+				savedId = await (s.SaveAsync(basic, cancellationToken)); 
+				await (s.FlushAsync(cancellationToken));
+			}
+			using (var s = OpenSession())
+			{
+				basic = await (s.GetAsync<DateClass>(savedId, cancellationToken));
+				Assert.That(basic.DateValue, Is.EqualTo(expected));
+				await (s.DeleteAsync(basic, cancellationToken));
+				await (s.FlushAsync(cancellationToken));
+			}
+		}
+	}
+}

src/NHibernate.Test/TypesTest/DateTypeTest.cs

@@ -13,25 +13,32 @@ public class DateTypeTest
 		public void WhenNoParameterThenDefaultValueIsBaseDateValue()
 		{
 			var dateType = new DateType();
+#pragma warning disable CS0618 // Type or member is obsolete
 			Assert.That(dateType.DefaultValue, Is.EqualTo(DateType.BaseDateValue));
+#pragma warning restore CS0618 // Type or member is obsolete
 		}
 
 		[Test]
 		public void WhenSetParameterThenDefaultValueIsParameterValue()
 		{
 			var dateType = new DateType();
-			dateType.SetParameterValues(new Dictionary<string, string>{{DateType.BaseValueParameterName, "0001/01/01"}});
+#pragma warning disable CS0618 // Type or member is obsolete
+			dateType.SetParameterValues(new Dictionary<string, string> { { DateType.BaseValueParameterName, "0001/01/01" } });
+#pragma warning restore CS0618 // Type or member is obsolete
 			Assert.That(dateType.DefaultValue, Is.EqualTo(DateTime.MinValue));
 		}
 
 		[Test]
 		public void WhenSetParameterNullThenNotThrow()
 		{
 			var dateType = new DateType();
+#pragma warning disable CS0618 // Type or member is obsolete
 			Assert.That(() => dateType.SetParameterValues(null), Throws.Nothing);
+#pragma warning restore CS0618 // Type or member is obsolete
 		}
 	}
 
+	[TestFixture]
 	public class DateTypeFixture : TypeFixtureBase
 	{
 		protected override string TypeName
@@ -55,36 +62,30 @@ public void ReadWriteNormal()
 		{
 			var expected = DateTime.Today.Date;
 
-			var basic = new DateClass { DateValue = expected.AddHours(1) };
-			object savedId;
-			using (ISession s = OpenSession())
-			{
-				savedId = s.Save(basic);
-				s.Flush();
-			}
-			using (ISession s = OpenSession())
-			{
-				basic = s.Get<DateClass>(savedId);
-				Assert.That(basic.DateValue, Is.EqualTo(expected));
-				s.Delete(basic);
-				s.Flush();
-			}
+			ReadWrite(expected);
 		}
 
 		[Test]
-		public void ReadWriteBaseValue()
+		public void ReadWriteMin()
 		{
-			var basic = new DateClass { DateValue = new DateTime(1899,1,1) };
+			var expected = DateTime.MinValue;
+
+			ReadWrite(expected);
+		}
+
+		private void ReadWrite(DateTime expected)
+		{
+			var basic = new DateClass { DateValue = expected.AddHours(1) };
 			object savedId;
-			using (ISession s = OpenSession())
+			using (var s = OpenSession())
 			{
-				savedId = s.Save(basic);
+				savedId = s.Save(basic); 
 				s.Flush();
 			}
-			using (ISession s = OpenSession())
+			using (var s = OpenSession())
 			{
 				basic = s.Get<DateClass>(savedId);
-				Assert.That(basic.DateValue.HasValue, Is.False);
+				Assert.That(basic.DateValue, Is.EqualTo(expected));
 				s.Delete(basic);
 				s.Flush();
 			}

src/NHibernate/Driver/Sql2008ClientDriver.cs

@@ -11,12 +11,17 @@ public class Sql2008ClientDriver : SqlClientDriver
 		protected override void InitializeParameter(DbParameter dbParam, string name, SqlTypes.SqlType sqlType)
 		{
 			base.InitializeParameter(dbParam, name, sqlType);
-			if (sqlType.DbType == DbType.Time)
+			switch (sqlType.DbType)
 			{
-				((SqlParameter) dbParam).SqlDbType = SqlDbType.Time;
+				case DbType.Time:
+					((SqlParameter) dbParam).SqlDbType = SqlDbType.Time;
+					break;
+				case DbType.Date:
+					((SqlParameter) dbParam).SqlDbType = SqlDbType.Date;
+					break;
 			}
 		}
 
 		public override bool RequiresTimeSpanForTime => true;
 	}
-}
+}

src/NHibernate/Type/DateType.cs

@@ -15,9 +15,16 @@ namespace NHibernate.Type
 	[Serializable]
 	public class DateType : PrimitiveType, IIdentifierType, ILiteralType, IParameterizedType
 	{
+		private static readonly IInternalLogger _log = LoggerProvider.LoggerFor(typeof(DateType));
+		// Since v5.0
+		[Obsolete("Explicitly affect your values to your entities properties instead.")]
 		public const string BaseValueParameterName = "BaseValue";
-		public static readonly DateTime BaseDateValue = new DateTime(1753, 01, 01);
-		private DateTime customBaseDate = BaseDateValue;
+		// Since v5.0
+		[Obsolete("Use DateTime.MinValue.")]
+		public static readonly DateTime BaseDateValue = _baseDateValue;
+		private DateTime customBaseDate = _baseDateValue;
+
+		private static readonly DateTime _baseDateValue = DateTime.MinValue;
 
 		/// <summary></summary>
 		public DateType() : base(SqlTypeFactory.Date)
@@ -57,8 +64,7 @@ public override void Set(DbCommand st, object value, int index, ISessionImplemen
 		{
 			var parm = st.Parameters[index];
 			var dateTime = (DateTime)value;
-			if (dateTime < customBaseDate) parm.Value = DBNull.Value;
-			else parm.Value = dateTime.Date;
+			parm.Value = dateTime.Date;
 		}
 
 		public override bool IsEqual(object x, object y)
@@ -125,6 +131,8 @@ public override string ObjectToSQLString(object value, Dialect.Dialect dialect)
 			return "\'" + ((DateTime)value).ToShortDateString() + "\'";
 		}
 
+		// Since v5
+		[Obsolete("Its only parameter, BaseValue, is obsolete.")]
 		public void SetParameterValues(IDictionary<string, string> parameters)
 		{
 			if(parameters == null)
@@ -134,8 +142,11 @@ public void SetParameterValues(IDictionary<string, string> parameters)
 			string value;
 			if (parameters.TryGetValue(BaseValueParameterName, out value))
 			{
+				_log.WarnFormat(
+					"Parameter {0} is obsolete and will be remove in a future version. Explicitly affect your values to your entities properties instead.",
+					BaseValueParameterName);
 				customBaseDate = DateTime.Parse(value);
 			}
 		}
 	}
-}
+}