-
Notifications
You must be signed in to change notification settings - Fork 317
fix: fixed date time deserializer #827
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -27,8 +27,21 @@ | |||||
| } | ||||||
| } | ||||||
|
|
||||||
| public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer) | ||||||
|
Check failure on line 30 in src/Twilio/Converters/CustomConverters.cs
|
||||||
| { | ||||||
| if (reader.TokenType == JsonToken.Null) | ||||||
| { | ||||||
| return null; | ||||||
| } | ||||||
| if (reader.TokenType == JsonToken.Date) | ||||||
| { | ||||||
| var dt = ConvertToDateTime(reader.Value); | ||||||
| if (objectType == typeof(List<DateTime>)) | ||||||
| { | ||||||
| return new List<DateTime> { dt }; | ||||||
| } | ||||||
| return dt; | ||||||
| } | ||||||
|
Comment on lines
+36
to
+44
|
||||||
| if (reader.TokenType == JsonToken.StartArray) | ||||||
| { | ||||||
| var dateTimes = new List<DateTime>(); | ||||||
|
|
@@ -42,6 +55,10 @@ | |||||
| dateTimes.Add(dateTime); | ||||||
| } | ||||||
| } | ||||||
| else if (reader.TokenType == JsonToken.Date) | ||||||
| { | ||||||
| dateTimes.Add(ConvertToDateTime(reader.Value)); | ||||||
| } | ||||||
|
Comment on lines
32
to
+61
|
||||||
| else if (reader.TokenType == JsonToken.EndArray) | ||||||
| { | ||||||
| return dateTimes; | ||||||
|
|
@@ -58,6 +75,15 @@ | |||||
| throw new JsonSerializationException("Failed to deserialize DateTime."); | ||||||
| } | ||||||
|
|
||||||
| private static DateTime ConvertToDateTime(object value) | ||||||
| { | ||||||
| if (value is DateTime dt) | ||||||
| return dt; | ||||||
| if (value is DateTimeOffset dto) | ||||||
| return dto.DateTime; | ||||||
|
||||||
| return dto.DateTime; | |
| return dto.UtcDateTime; |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,107 @@ | ||
| using System; | ||
| using System.Collections.Generic; | ||
| using Newtonsoft.Json; | ||
| using NUnit.Framework; | ||
| using Twilio.Converters; | ||
|
|
||
| namespace Twilio.Tests.Converters | ||
| { | ||
| [TestFixture] | ||
| public class DateTimeConverterTest | ||
| { | ||
| private class SingleDateModel | ||
| { | ||
| [JsonConverter(typeof(DateTimeConverter))] | ||
| public DateTime? Date { get; set; } | ||
| } | ||
|
|
||
| private class DateListModel | ||
| { | ||
| [JsonConverter(typeof(DateTimeConverter))] | ||
| public List<DateTime> Dates { get; set; } | ||
| } | ||
|
|
||
| [Test] | ||
| public void TestDeserializeNullToken() | ||
| { | ||
| var json = "{\"Date\": null}"; | ||
| var result = JsonConvert.DeserializeObject<SingleDateModel>(json); | ||
| Assert.IsNull(result.Date); | ||
|
Check warning on line 29 in test/Twilio.Test/Converters/DateTimeConverterTest.cs
|
||
| } | ||
|
|
||
| [Test] | ||
| public void TestDeserializeDateToken() | ||
| { | ||
| var settings = new JsonSerializerSettings { DateParseHandling = DateParseHandling.DateTime }; | ||
| var json = "{\"Date\": \"2024-06-15T10:30:00Z\"}"; | ||
| var result = JsonConvert.DeserializeObject<SingleDateModel>(json, settings); | ||
| Assert.IsNotNull(result.Date); | ||
|
Check warning on line 38 in test/Twilio.Test/Converters/DateTimeConverterTest.cs
|
||
| Assert.AreEqual(2024, result.Date.Value.Year); | ||
|
Check warning on line 39 in test/Twilio.Test/Converters/DateTimeConverterTest.cs
|
||
| Assert.AreEqual(6, result.Date.Value.Month); | ||
| Assert.AreEqual(15, result.Date.Value.Day); | ||
| } | ||
|
|
||
| [Test] | ||
| public void TestDeserializeDateTimeOffsetToken() | ||
| { | ||
| var settings = new JsonSerializerSettings { DateParseHandling = DateParseHandling.DateTimeOffset }; | ||
| var json = "{\"Date\": \"2024-06-15T10:30:00Z\"}"; | ||
| var result = JsonConvert.DeserializeObject<SingleDateModel>(json, settings); | ||
| Assert.IsNotNull(result.Date); | ||
|
Check warning on line 50 in test/Twilio.Test/Converters/DateTimeConverterTest.cs
|
||
| Assert.AreEqual(2024, result.Date.Value.Year); | ||
|
Check warning on line 51 in test/Twilio.Test/Converters/DateTimeConverterTest.cs
|
||
| Assert.AreEqual(6, result.Date.Value.Month); | ||
| Assert.AreEqual(15, result.Date.Value.Day); | ||
| } | ||
|
Comment on lines
+45
to
+54
|
||
|
|
||
| [Test] | ||
| public void TestDeserializeStringToken() | ||
| { | ||
| var settings = new JsonSerializerSettings { DateParseHandling = DateParseHandling.None }; | ||
| var json = "{\"Date\": \"2024-06-15T10:30:00Z\"}"; | ||
| var result = JsonConvert.DeserializeObject<SingleDateModel>(json, settings); | ||
| Assert.IsNotNull(result.Date); | ||
|
Check warning on line 62 in test/Twilio.Test/Converters/DateTimeConverterTest.cs
|
||
| Assert.AreEqual(2024, result.Date.Value.Year); | ||
|
Check warning on line 63 in test/Twilio.Test/Converters/DateTimeConverterTest.cs
|
||
| } | ||
|
|
||
| [Test] | ||
| public void TestDeserializeArrayOfDateStrings() | ||
| { | ||
| var settings = new JsonSerializerSettings { DateParseHandling = DateParseHandling.None }; | ||
| var json = "{\"Dates\": [\"2024-01-01T00:00:00Z\", \"2024-12-31T00:00:00Z\"]}"; | ||
| var result = JsonConvert.DeserializeObject<DateListModel>(json, settings); | ||
| Assert.AreEqual(2, result.Dates.Count); | ||
|
Check warning on line 72 in test/Twilio.Test/Converters/DateTimeConverterTest.cs
|
||
| Assert.AreEqual(1, result.Dates[0].Month); | ||
| Assert.AreEqual(12, result.Dates[1].Month); | ||
| } | ||
|
|
||
| [Test] | ||
| public void TestDeserializeArrayOfDateTokens() | ||
| { | ||
| var settings = new JsonSerializerSettings { DateParseHandling = DateParseHandling.DateTime }; | ||
| var json = "{\"Dates\": [\"2024-01-01T00:00:00Z\", \"2024-12-31T00:00:00Z\"]}"; | ||
| var result = JsonConvert.DeserializeObject<DateListModel>(json, settings); | ||
| Assert.AreEqual(2, result.Dates.Count); | ||
|
Check warning on line 83 in test/Twilio.Test/Converters/DateTimeConverterTest.cs
|
||
| Assert.AreEqual(1, result.Dates[0].Month); | ||
| Assert.AreEqual(12, result.Dates[1].Month); | ||
| } | ||
|
|
||
| [Test] | ||
| public void TestDeserializeArrayOfDateTimeOffsetTokens() | ||
| { | ||
| var settings = new JsonSerializerSettings { DateParseHandling = DateParseHandling.DateTimeOffset }; | ||
| var json = "{\"Dates\": [\"2024-01-01T00:00:00Z\", \"2024-12-31T00:00:00Z\"]}"; | ||
| var result = JsonConvert.DeserializeObject<DateListModel>(json, settings); | ||
| Assert.AreEqual(2, result.Dates.Count); | ||
|
Check warning on line 94 in test/Twilio.Test/Converters/DateTimeConverterTest.cs
|
||
| Assert.AreEqual(1, result.Dates[0].Month); | ||
| Assert.AreEqual(12, result.Dates[1].Month); | ||
| } | ||
|
|
||
| [Test] | ||
| public void TestDeserializeInvalidTokenThrows() | ||
| { | ||
| var json = "{\"Date\": 12345}"; | ||
| Assert.Throws<JsonSerializationException>(() => | ||
| JsonConvert.DeserializeObject<SingleDateModel>(json)); | ||
| } | ||
| } | ||
| } | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ReadJsonreturns aDateTimeforJsonToken.Dateregardless ofobjectType. If this converter is used forList<DateTime>, a non-array JSON value (e.g., a single date) will cause the converter to return the wrong runtime type and Newtonsoft will throw during assignment. Consider branching onobjectTypeand either (a) wrapping a single date into a singleton list forList<DateTime>or (b) throwing a clear exception when the JSON shape doesn't match the target type (and similarly avoid returning a list whenobjectTypeisDateTime?).