-Cleaned up UnixDateTimeConverter

This commit is contained in:
James Newton-King
2018-01-21 12:16:48 +13:00
parent d7786d86c1
commit 0b975a2087
2 changed files with 74 additions and 41 deletions
@@ -33,6 +33,7 @@ using Assert = Newtonsoft.Json.Tests.XUnitAssert;
using NUnit.Framework; using NUnit.Framework;
#endif #endif
using Newtonsoft.Json.Converters; using Newtonsoft.Json.Converters;
using Newtonsoft.Json.Linq;
using Newtonsoft.Json.Tests.TestObjects; using Newtonsoft.Json.Tests.TestObjects;
namespace Newtonsoft.Json.Tests.Converters namespace Newtonsoft.Json.Tests.Converters
@@ -43,7 +44,7 @@ namespace Newtonsoft.Json.Tests.Converters
[Test] [Test]
public void SerializeDateTime() public void SerializeDateTime()
{ {
DateTime unixEpoch = new DateTime(1970, 1, 1, 0, 0, 0, DateTimeKind.Utc); DateTime unixEpoch = UnixDateTimeConverter.UnixEpoch;
string result = JsonConvert.SerializeObject(unixEpoch, new UnixDateTimeConverter()); string result = JsonConvert.SerializeObject(unixEpoch, new UnixDateTimeConverter());
@@ -66,7 +67,18 @@ namespace Newtonsoft.Json.Tests.Converters
{ {
ExceptionAssert.Throws<JsonSerializationException>( ExceptionAssert.Throws<JsonSerializationException>(
() => JsonConvert.SerializeObject(new DateTime(1964, 2, 7), new UnixDateTimeConverter()), () => JsonConvert.SerializeObject(new DateTime(1964, 2, 7), new UnixDateTimeConverter()),
"Expected a valid Unix date." "Cannot convert date value that is before Unix epoch of 00:00:00 UTC on 1 January 1970."
);
}
[Test]
public void WriteJsonInvalidType()
{
UnixDateTimeConverter converter = new UnixDateTimeConverter();
ExceptionAssert.Throws<JsonSerializationException>(
() => converter.WriteJson(new JTokenWriter(), new object(), new JsonSerializer()),
"Expected date object value."
); );
} }
@@ -138,6 +150,15 @@ namespace Newtonsoft.Json.Tests.Converters
Assert.AreEqual(new DateTimeOffset(2018, 1, 1, 21, 1, 16, TimeSpan.Zero), result); Assert.AreEqual(new DateTimeOffset(2018, 1, 1, 21, 1, 16, TimeSpan.Zero), result);
} }
[Test]
public void DeserializeInvalidStringToDateTimeOffset()
{
ExceptionAssert.Throws<JsonSerializationException>(
() => JsonConvert.DeserializeObject<DateTimeOffset>(@"""PIE""", new UnixDateTimeConverter()),
"Cannot convert invalid value to System.DateTimeOffset. Path '', line 1, position 5."
);
}
#endif #endif
[Test] [Test]
@@ -159,18 +180,18 @@ namespace Newtonsoft.Json.Tests.Converters
[Test] [Test]
public void DeserializeInvalidValue() public void DeserializeInvalidValue()
{ {
ExceptionAssert.Throws<Exception>( ExceptionAssert.Throws<JsonSerializationException>(
() => JsonConvert.DeserializeObject<DateTime>("-1", new UnixDateTimeConverter()), () => JsonConvert.DeserializeObject<DateTime>("-1", new UnixDateTimeConverter()),
"Cannot convert invalid value -1 to System.DateTime. Path '', line 1, position 2." "Cannot convert value that is before Unix epoch of 00:00:00 UTC on 1 January 1970 to System.DateTime. Path '', line 1, position 2."
); );
} }
[Test] [Test]
public void DeserializeInvalidValueType() public void DeserializeInvalidValueType()
{ {
ExceptionAssert.Throws<Exception>( ExceptionAssert.Throws<JsonSerializationException>(
() => JsonConvert.DeserializeObject<DateTime>("false", new UnixDateTimeConverter()), () => JsonConvert.DeserializeObject<DateTime>("false", new UnixDateTimeConverter()),
"Cannot convert invalid value to System.DateTime. Path '', line 1, position 5." "Unexpected token parsing date. Expected Integer or String, got Boolean. Path '', line 1, position 5."
); );
} }
@@ -34,10 +34,7 @@ namespace Newtonsoft.Json.Converters
/// </summary> /// </summary>
public class UnixDateTimeConverter : DateTimeConverterBase public class UnixDateTimeConverter : DateTimeConverterBase
{ {
/// <summary> internal static readonly DateTime UnixEpoch = new DateTime(1970, 1, 1, 0, 0, 0, DateTimeKind.Utc);
/// Unix epoch time. Thursday, January 1, 1970 12:00:00 AM GMT
/// </summary>
public readonly DateTime UnixEpoch = new DateTime(1970, 1, 1, 0, 0, 0, DateTimeKind.Utc);
/// <summary> /// <summary>
/// Writes the JSON representation of the object. /// Writes the JSON representation of the object.
@@ -47,7 +44,7 @@ namespace Newtonsoft.Json.Converters
/// <param name="serializer">The calling serializer.</param> /// <param name="serializer">The calling serializer.</param>
public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer) public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer)
{ {
long ticks = default; long ticks;
if (value is DateTime dateTime) if (value is DateTime dateTime)
{ {
@@ -59,10 +56,14 @@ namespace Newtonsoft.Json.Converters
ticks = (long)(dateTimeOffset.ToUniversalTime() - UnixEpoch).TotalSeconds; ticks = (long)(dateTimeOffset.ToUniversalTime() - UnixEpoch).TotalSeconds;
} }
#endif #endif
else
{
throw new JsonSerializationException("Expected date object value.");
}
if (ticks < 0) if (ticks < 0)
{ {
throw new JsonSerializationException("Expected a valid Unix date."); throw new JsonSerializationException("Cannot convert date value that is before Unix epoch of 00:00:00 UTC on 1 January 1970.");
} }
writer.WriteValue(ticks); writer.WriteValue(ticks);
@@ -78,43 +79,54 @@ namespace Newtonsoft.Json.Converters
/// <returns>The object value.</returns> /// <returns>The object value.</returns>
public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer) public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
{ {
bool nullable = ReflectionUtils.IsNullable(objectType);
if (reader.TokenType == JsonToken.Null) if (reader.TokenType == JsonToken.Null)
{ {
if (ReflectionUtils.IsNullable(objectType)) if (!nullable)
return null; {
else throw JsonSerializationException.Create(reader, "Cannot convert null value to {0}.".FormatWith(CultureInfo.InvariantCulture, objectType));
throw JsonSerializationException.Create( }
reader, "Cannot convert null value to {0}.".FormatWith(CultureInfo.InvariantCulture, objectType)
); return null;
} }
if (long.TryParse(reader.Value + "", out long ticks)) long ticks;
{
if (ticks >= 0)
{
DateTime d = UnixEpoch.AddSeconds(ticks);
#if HAVE_DATE_TIME_OFFSET if (reader.TokenType == JsonToken.Integer)
Type t = (ReflectionUtils.IsNullableType(objectType)) {
? Nullable.GetUnderlyingType(objectType) ticks = (long)reader.Value;
: objectType; }
if (t == typeof(DateTimeOffset)) else if (reader.TokenType == JsonToken.String)
{ {
return new DateTimeOffset(d, TimeSpan.Zero); if (!long.TryParse((string)reader.Value, out ticks))
} {
#endif throw JsonSerializationException.Create(reader, "Cannot convert invalid value to {0}.".FormatWith(CultureInfo.InvariantCulture, objectType));
return d;
} }
else
throw JsonSerializationException.Create(
reader, "Cannot convert invalid value {0} to {1}."
.FormatWith(CultureInfo.InvariantCulture, ticks, objectType)
);
} }
else else
throw JsonSerializationException.Create( {
reader, "Cannot convert invalid value to {0}.".FormatWith(CultureInfo.InvariantCulture, objectType) throw JsonSerializationException.Create(reader, "Unexpected token parsing date. Expected Integer or String, got {0}.".FormatWith(CultureInfo.InvariantCulture, reader.TokenType));
); }
if (ticks >= 0)
{
DateTime d = UnixEpoch.AddSeconds(ticks);
#if HAVE_DATE_TIME_OFFSET
Type t = (nullable)
? Nullable.GetUnderlyingType(objectType)
: objectType;
if (t == typeof(DateTimeOffset))
{
return new DateTimeOffset(d, TimeSpan.Zero);
}
#endif
return d;
}
else
{
throw JsonSerializationException.Create(reader, "Cannot convert value that is before Unix epoch of 00:00:00 UTC on 1 January 1970 to {0}.".FormatWith(CultureInfo.InvariantCulture, objectType));
}
} }
} }
} }