Skip to content
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.

Sign up for GitHub

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

Jump to bottom

DateOnly and TimeOnly support #1702

Merged
merged 6 commits into from Jul 26, 2022
Merged

DateOnly and TimeOnly support #1702

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
49ca4b5
.
SimonCropp Jul 25, 2022
1696b3e
.
SimonCropp Jul 25, 2022
c7aef48
Update global.json
SimonCropp Jul 25, 2022
77c49ac
Merge branch 'dev' into dateOnlyAndTimeOnly
nblumhardt Jul 25, 2022
2305dd4
FEATURE_DATE_AND_TIME_ONLY
SimonCropp Jul 25, 2022
33b3e8d
Update PropertyValueConverter.cs
SimonCropp Jul 25, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions Serilog.sln.DotSettings
View file
Open in desktop
Expand Up @@ -195,6 +195,7 @@
<s:String x:Key="/Default/CodeStyle/Naming/VBNaming/PredefinedNamingRules/=StaticReadonly/@EntryIndexedValue">&lt;Policy Inspect="True" Prefix="" Suffix="" Style="AaBb" /&gt;</s:String>
<s:String x:Key="/Default/CodeStyle/Naming/VBNaming/PredefinedNamingRules/=TypeParameters/@EntryIndexedValue">&lt;Policy Inspect="True" Prefix="T" Suffix="" Style="AaBb" /&gt;</s:String>
<s:String x:Key="/Default/CodeStyle/Naming/VBNaming/PredefinedNamingRules/=TypesAndNamespaces/@EntryIndexedValue">&lt;Policy Inspect="True" Prefix="" Suffix="" Style="AaBb" /&gt;</s:String>
<s:Boolean x:Key="/Default/Environment/SettingsMigration/IsMigratorApplied/=JetBrains_002EdotCover_002EIde_002ECore_002EFilterManagement_002EModel_002ESolutionFilterSettingsManagerMigrateSettings/@EntryIndexedValue">True</s:Boolean>
<s:Boolean x:Key="/Default/Environment/SettingsMigration/IsMigratorApplied/=JetBrains_002EReSharper_002EPsi_002ECSharp_002ECodeStyle_002ECSharpAttributeForSingleLineMethodUpgrade/@EntryIndexedValue">True</s:Boolean>
<s:Boolean x:Key="/Default/Environment/SettingsMigration/IsMigratorApplied/=JetBrains_002EReSharper_002EPsi_002ECSharp_002ECodeStyle_002ECSharpFileLayoutPatternsUpgrade/@EntryIndexedValue">True</s:Boolean>
<s:Boolean x:Key="/Default/Environment/SettingsMigration/IsMigratorApplied/=JetBrains_002EReSharper_002EPsi_002ECSharp_002ECodeStyle_002ECSharpKeepExistingMigration/@EntryIndexedValue">True</s:Boolean>
Expand Down
5 changes: 4 additions & 1 deletion src/Serilog/Capturing/PropertyValueConverter.cs
View file
Open in desktop
Expand Up @@ -42,7 +42,10 @@ partial class PropertyValueConverter : ILogEventPropertyFactory, ILogEventProper
typeof(long), typeof(ulong), typeof(float), typeof(double), typeof(decimal),
typeof(string),
typeof(DateTime), typeof(DateTimeOffset), typeof(TimeSpan),
typeof(Guid), typeof(Uri)
typeof(Guid), typeof(Uri),
#if NET6_OR_GREATER
SimonCropp marked this conversation as resolved.
Show resolved Hide resolved
SimonCropp marked this conversation as resolved.
Show resolved Hide resolved
typeof(TimeOnly), typeof(DateOnly)
#endif
};

readonly IDestructuringPolicy[] _destructuringPolicies;
Expand Down
22 changes: 22 additions & 0 deletions src/Serilog/Formatting/Json/JsonFormatter.cs
View file
Open in desktop
Expand Up @@ -103,6 +103,10 @@ public class JsonFormatter : ITextFormatter
{ typeof(string), (v, _, w) => WriteString((string)v, w) },
{ typeof(DateTime), (v, _, w) => WriteDateTime((DateTime)v, w) },
{ typeof(DateTimeOffset), (v, _, w) => WriteOffset((DateTimeOffset)v, w) },
#if FEATURE_DATE_AND_TIME_ONLY
{ typeof(DateOnly), (v, _, w) => WriteDateOnly((DateOnly)v, w) },
{ typeof(TimeOnly), (v, _, w) => WriteTimeOnly((TimeOnly)v, w) },
#endif
{ typeof(ScalarValue), (v, q, w) => WriteLiteral(((ScalarValue)v).Value, w, q) },
{ typeof(SequenceValue), (v, _, w) => WriteSequence(((SequenceValue)v).Elements, w) },
{ typeof(DictionaryValue), (v, _, w) => WriteDictionary(((DictionaryValue)v).Elements, w) },
Expand Down Expand Up @@ -429,6 +433,24 @@ static void WriteDateTime(DateTime value, TextWriter output)
output.Write("\"");
}

#if FEATURE_DATE_AND_TIME_ONLY

static void WriteDateOnly(DateOnly value, TextWriter output)
{
output.Write("\"");
output.Write(value.ToString("yyyy-MM-dd"));
output.Write("\"");
}

static void WriteTimeOnly(TimeOnly value, TextWriter output)
{
output.Write("\"");
output.Write(value.ToString("O"));
output.Write("\"");
}

#endif

static void WriteString(string value, TextWriter output)
{
JsonValueFormatter.WriteQuotedJsonString(value, output);
Expand Down
32 changes: 32 additions & 0 deletions src/Serilog/Formatting/Json/JsonValueFormatter.cs
View file
Open in desktop
Expand Up @@ -219,6 +219,20 @@ protected virtual void FormatLiteralValue(object value, TextWriter output)
FormatTimeSpanValue(timeSpan, output);
return;
}

#if FEATURE_DATE_AND_TIME_ONLY
if (value is DateOnly dateOnly)
{
FormatDateOnlyValue(dateOnly, output);
return;
}

if (value is TimeOnly timeOnly)
{
FormatTimeOnlyValue(timeOnly, output);
return;
}
#endif
}

FormatLiteralObjectValue(value, output);
Expand Down Expand Up @@ -270,6 +284,24 @@ static void FormatTimeSpanValue(TimeSpan value, TextWriter output)
output.Write('\"');
}

#if FEATURE_DATE_AND_TIME_ONLY

static void FormatDateOnlyValue(DateOnly value, TextWriter output)
{
output.Write('\"');
output.Write(value.ToString("yyyy-MM-dd"));
output.Write('\"');
}

static void FormatTimeOnlyValue(TimeOnly value, TextWriter output)
{
output.Write('\"');
output.Write(value.ToString("O"));
output.Write('\"');
}

#endif

static void FormatLiteralObjectValue(object value, TextWriter output)
{
if (value == null) throw new ArgumentNullException(nameof(value));
Expand Down
2 changes: 1 addition & 1 deletion src/Serilog/Serilog.csproj
View file
Open in desktop
Expand Up @@ -46,7 +46,7 @@
</PropertyGroup>

<PropertyGroup Condition=" '$(TargetFramework)' == 'net6.0' ">
<DefineConstants>$(DefineConstants);ASYNCLOCAL;HASHTABLE;FEATURE_DEFAULT_INTERFACE;FEATURE_SPAN</DefineConstants>
<DefineConstants>$(DefineConstants);ASYNCLOCAL;HASHTABLE;FEATURE_DEFAULT_INTERFACE;FEATURE_SPAN;FEATURE_DATE_AND_TIME_ONLY</DefineConstants>
</PropertyGroup>

<ItemGroup Condition=" '$(TargetFramework)' == 'netstandard1.3' ">
Expand Down
36 changes: 36 additions & 0 deletions test/Serilog.Tests/Formatting/Json/JsonFormatterTests.cs
View file
Open in desktop
Expand Up @@ -31,6 +31,42 @@ public void JsonFormattedEventsIncludeTimestamp()
(string)formatted.Timestamp);
}

#if FEATURE_DATE_AND_TIME_ONLY

[Fact]
public void JsonFormattedDateOnly()
{
var @event = new LogEvent(
DateTimeOffset.MaxValue,
LogEventLevel.Information,
null,
Some.MessageTemplate(),
new[] {new LogEventProperty("name", new ScalarValue(DateOnly.MaxValue))});

var formatted = FormatJson(@event);
Assert.Equal(
"9999-12-31",
(string) formatted.Properties.name);
}

[Fact]
public void JsonFormattedTimeOnly()
{
var @event = new LogEvent(
DateTimeOffset.MaxValue,
LogEventLevel.Information,
null,
Some.MessageTemplate(),
new[] {new LogEventProperty("name", new ScalarValue(TimeOnly.MaxValue))});

var formatted = FormatJson(@event);
Assert.Equal(
"23:59:59.9999999",
(string) formatted.Properties.name);
}

#endif

static string FormatToJson(LogEvent @event)
{
var formatter = new JsonFormatter();
Expand Down
16 changes: 16 additions & 0 deletions test/Serilog.Tests/Formatting/Json/JsonValueFormatterTests.cs
View file
Open in desktop
Expand Up @@ -51,6 +51,22 @@ public void DateTimesFormatAsIso8601()
JsonLiteralTypesAreFormatted(new DateTime(2016, 01, 01, 13, 13, 13, DateTimeKind.Utc), "\"2016-01-01T13:13:13.0000000Z\"");
}

#if FEATURE_DATE_AND_TIME_ONLY

[Fact]
public void DateOnly()
{
JsonLiteralTypesAreFormatted(new DateOnly(2016, 01, 01), "\"2016-01-01\"");
}

[Fact]
public void TimeOnly()
{
JsonLiteralTypesAreFormatted(new TimeOnly(13, 01, 01, 999), "\"13:01:01.9990000\"");
}

#endif

[Fact]
public void DoubleFormatsAsNumber()
{
Expand Down
2 changes: 1 addition & 1 deletion test/Serilog.Tests/Serilog.Tests.csproj
View file
Open in desktop
Expand Up @@ -40,6 +40,6 @@
<DefineConstants>$(DefineConstants);ASYNCLOCAL;FEATURE_DEFAULT_INTERFACE;FEATURE_SPAN</DefineConstants>
</PropertyGroup>
<PropertyGroup Condition=" '$(TargetFramework)' == 'net6.0' ">
<DefineConstants>$(DefineConstants);ASYNCLOCAL;FEATURE_DEFAULT_INTERFACE;FEATURE_SPAN</DefineConstants>
<DefineConstants>$(DefineConstants);ASYNCLOCAL;FEATURE_DEFAULT_INTERFACE;FEATURE_SPAN;FEATURE_DATE_AND_TIME_ONLY</DefineConstants>
</PropertyGroup>
</Project>