Skip to content

JSON Console Logger not requiring scopes to implement IReadOnlyCollection #48453

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

Merged
tarekgh merged 3 commits into from
Feb 19, 2021
Merged

JSON Console Logger not requiring scopes to implement IReadOnlyCollection #48453

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
20dcbe5
Merge pull request #1 from dotnet/master
daveMueller Feb 11, 2021
e988f11
Changed scopes to require IEnumerable
daveMueller Feb 18, 2021
ae8a8a0
Added test
daveMueller Feb 18, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/libraries/Microsoft.Extensions.Logging.Console/src/JsonConsoleFormatter.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ private void WriteScopeInformation(Utf8JsonWriter writer, IExternalScopeProvider
writer.WriteStartArray("Scopes");
scopeProvider.ForEachScope((scope, state) =>
{
if (scope is IReadOnlyCollection<KeyValuePair<string, object>> scopes)
if (scope is IEnumerable<KeyValuePair<string, object>> scopes)
{
state.WriteStartObject();
state.WriteString("Message", scope.ToString());
Expand Down
29 changes: 29 additions & 0 deletions ...ing.Console/tests/Microsoft.Extensions.Logging.Console.Tests/JsonConsoleFormatterTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -342,6 +342,35 @@ public void Log_StateAndScopeContainsNullValue_SerializesNull()
Assert.Contains("\"LogKey\":null", message);
}

[ConditionalFact(typeof(PlatformDetection), nameof(PlatformDetection.IsThreadingSupported))]
public void Log_ScopeIsIEnumerable_SerializesKeyValuePair()
{
// Arrange
var t = SetUp(
new ConsoleLoggerOptions { FormatterName = ConsoleFormatterNames.Json },
simpleOptions: null,
systemdOptions: null,
jsonOptions: new JsonConsoleFormatterOptions
{
JsonWriterOptions = new JsonWriterOptions() { Indented = false },
IncludeScopes = true
}
);
var logger = (ILogger)t.Logger;
var sink = t.Sink;

// Act
using (logger.BeginScope(new[] { 2 }.Select(x => new KeyValuePair<string, object>("Value", x))))
{
logger.LogInformation("{LogEntryNumber}", 1);
}

// Assert
string message = sink.Writes[0].Message;
Assert.Contains("\"Message\":\"System.Linq.Enumerable", message);
Assert.Contains("\"Value\":" + 2, message);
}

public static TheoryData<object, string> SpecialCaseValues
{
get
Expand Down