Skip to content

Commit

Permalink
- replace nameof(Generator) with "LoggerMessage"
Browse files Browse the repository at this point in the history 
- bugfix: up to 6 params, use LoggerMessage.Define
- bugfix: "__Enumerate" method was missing for IEnumerable arguments
- change "__Enumerate" method: made part of a utility method, generated once in __LoggerMessageGenerator
  • Loading branch information
@maryamariyan
maryamariyan committed Apr 28, 2021
1 parent 38ecfc3 commit 35d0022
Show file tree
Hide file tree
Showing 5 changed files with 105 additions and 65 deletions.
93 changes: 44 additions & 49 deletions src/libraries/Microsoft.Extensions.Logging/gen/LoggerMessageGenerator.Emitter.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,12 @@ internal class Emitter
private const int MaxLoggerMessageDefineArguments = 6;
private const int DefaultStringBuilderCapacity = 1024;

private readonly string _generatedCodeAttribute =
private static readonly string _generatedCodeAttribute =
$"global::System.CodeDom.Compiler.GeneratedCodeAttribute(" +
$"\"{typeof(Emitter).Assembly.GetName().Name}\", " +
$"\"{typeof(Emitter).Assembly.GetName().Version}\")";
private readonly StringBuilder _builder = new StringBuilder(DefaultStringBuilderCapacity);
private bool _needEnumerationHelper;

public string Emit(IReadOnlyList<LoggerClass> logClasses, CancellationToken cancellationToken)
{
Expand All @@ -34,6 +35,7 @@ public string Emit(IReadOnlyList<LoggerClass> logClasses, CancellationToken canc
GenType(lc);
}

GenEnumerationHelper();
return _builder.ToString();
}

Expand All @@ -50,7 +52,7 @@ private static bool UseLoggerMessageDefine(LoggerMethod lm)
int count = 0;
foreach (string t in lm.TemplateList)
{
if (!t.Equals(lm.TemplateParameters[count].Name, StringComparison.OrdinalIgnoreCase))
if (!t.Equals(lm.TemplateParameters[count++].Name, StringComparison.OrdinalIgnoreCase))
{
// order doesn't match, can't use LoggerMessage.Define
return false;
Expand Down Expand Up @@ -84,8 +86,6 @@ partial class {lc.Name} {lc.Constraints}
GenLogMethod(lm);
}

GenEnumerationHelper(lc);

_builder.Append($@"
}}");

Expand Down Expand Up @@ -193,7 +193,9 @@ private void GenVariableAssignments(LoggerMethod lm)
if (lm.TemplateParameters[index].IsEnumerable)
{
_builder.AppendLine($" var {t.Key} = "
+ $"__Enumerate((global::System.Collections.IEnumerable ?)this._{lm.TemplateParameters[index].Name});");
+ $"global::__LoggerMessageGenerator.Enumerate((global::System.Collections.IEnumerable ?)this._{lm.TemplateParameters[index].Name});");

_needEnumerationHelper = true;
}
else
{
Expand Down Expand Up @@ -237,7 +239,7 @@ private void GenDefineTypes(LoggerMethod lm, bool brackets)
}
if (brackets)
{
_builder.Append("<");
_builder.Append('<');
}

bool firstItem = true;
Expand All @@ -257,7 +259,7 @@ private void GenDefineTypes(LoggerMethod lm, bool brackets)

if (brackets)
{
_builder.Append(">");
_builder.Append('>');
}
else
{
Expand Down Expand Up @@ -322,7 +324,7 @@ private void GenHolder(LoggerMethod lm)
private void GenLogMethod(LoggerMethod lm)
{
string level = GetLogLevel(lm);
string extension = (lm.IsExtensionMethod ? "this " : string.Empty);
string extension = lm.IsExtensionMethod ? "this " : string.Empty;
string eventName = string.IsNullOrWhiteSpace(lm.EventName) ? $"nameof({lm.Name})" : $"\"{lm.EventName}\"";
string exceptionArg = GetException(lm);
string logger = GetLogger(lm);
Expand Down Expand Up @@ -443,63 +445,56 @@ static string GetLogLevel(LoggerMethod lm)
}
}

private void GenEnumerationHelper(LoggerClass lc)
private void GenEnumerationHelper()
{
foreach (LoggerMethod lm in lc.Methods)
if (_needEnumerationHelper)
{
if (UseLoggerMessageDefine(lm))
{
foreach (LoggerParameter p in lm.TemplateParameters)
{
if (p.IsEnumerable)
{
_builder.Append($@"
[{_generatedCodeAttribute}]
private static string __Enumerate(global::System.Collections.IEnumerable? enumerable)
[{_generatedCodeAttribute}]
internal static class __LoggerMessageGenerator
{{
public static string Enumerate(global::System.Collections.IEnumerable? enumerable)
{{
if (enumerable == null)
{{
if (enumerable == null)
{{
return ""(null)"";
}}
return ""(null)"";
}}
var sb = new global::System.Text.StringBuilder();
_ = sb.Append('[');
var sb = new global::System.Text.StringBuilder();
_ = sb.Append('[');
bool first = true;
foreach (object e in enumerable)
bool first = true;
foreach (object e in enumerable)
{{
if (!first)
{{
if (!first)
{{
_ = sb.Append("", "");
}}
_ = sb.Append("", "");
}}
if (e == null)
if (e == null)
{{
_ = sb.Append(""(null)"");
}}
else
{{
if (e is global::System.IFormattable fmt)
{{
_ = sb.Append(""(null)"");
_ = sb.Append(fmt.ToString(null, global::System.Globalization.CultureInfo.InvariantCulture));
}}
else
{{
if (e is global::System.IFormattable fmt)
{{
_ = sb.Append(fmt.ToString(null, global::System.Globalization.CultureInfo.InvariantCulture));
}}
else
{{
_ = sb.Append(e);
}}
_ = sb.Append(e);
}}
first = false;
}}
_ = sb.Append(']');
return sb.ToString();
first = false;
}}
");
}
}
}
_ = sb.Append(']');
return sb.ToString();
}}
}}");
}
}
}
Expand Down
2 changes: 1 addition & 1 deletion src/libraries/Microsoft.Extensions.Logging/gen/LoggerMessageGenerator.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ public void Execute(GeneratorExecutionContext context)
var e = new Emitter();
string result = e.Emit(logClasses, context.CancellationToken);

context.AddSource(nameof(LoggerMessageGenerator), SourceText.From(result, Encoding.UTF8));
context.AddSource("LoggerMessage", SourceText.From(result, Encoding.UTF8));
}
}

Expand Down
53 changes: 49 additions & 4 deletions ...osoft.Extensions.Logging.Generators.Tests/Baselines/TestWithMoreThan6Params.generated.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@ namespace Microsoft.Extensions.Logging.Generators.Tests.TestClasses
private readonly global::System.Int32 _p4;
private readonly global::System.Int32 _p5;
private readonly global::System.Int32 _p6;
private readonly global::System.Int32 _p7;
private readonly global::System.Collections.Generic.IEnumerable<global::System.Int32> _p7;

public __Method9Struct(global::System.Int32 p1, global::System.Int32 p2, global::System.Int32 p3, global::System.Int32 p4, global::System.Int32 p5, global::System.Int32 p6, global::System.Int32 p7)
public __Method9Struct(global::System.Int32 p1, global::System.Int32 p2, global::System.Int32 p3, global::System.Int32 p4, global::System.Int32 p5, global::System.Int32 p6, global::System.Collections.Generic.IEnumerable<global::System.Int32> p7)
{
this._p1 = p1;
this._p2 = p2;
Expand All @@ -36,7 +36,7 @@ namespace Microsoft.Extensions.Logging.Generators.Tests.TestClasses
var p4 = this._p4;
var p5 = this._p5;
var p6 = this._p6;
var p7 = this._p7;
var p7 = global::__LoggerMessageGenerator.Enumerate((global::System.Collections.IEnumerable ?)this._p7);

return $"M9 {p1} {p2} {p3} {p4} {p5} {p6} {p7}";
}
Expand Down Expand Up @@ -74,7 +74,7 @@ namespace Microsoft.Extensions.Logging.Generators.Tests.TestClasses
}

[global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Extensions.Logging.Generators", "6.0.0.0")]
public static partial void Method9(global::Microsoft.Extensions.Logging.ILogger logger, global::System.Int32 p1, global::System.Int32 p2, global::System.Int32 p3, global::System.Int32 p4, global::System.Int32 p5, global::System.Int32 p6, global::System.Int32 p7)
public static partial void Method9(global::Microsoft.Extensions.Logging.ILogger logger, global::System.Int32 p1, global::System.Int32 p2, global::System.Int32 p3, global::System.Int32 p4, global::System.Int32 p5, global::System.Int32 p6, global::System.Collections.Generic.IEnumerable<global::System.Int32> p7)
{
if (logger.IsEnabled(global::Microsoft.Extensions.Logging.LogLevel.Error))
{
Expand All @@ -87,4 +87,49 @@ namespace Microsoft.Extensions.Logging.Generators.Tests.TestClasses
}
}
}
}
[global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Extensions.Logging.Generators", "6.0.0.0")]
internal static class __LoggerMessageGenerator
{
public static string Enumerate(global::System.Collections.IEnumerable? enumerable)
{
if (enumerable == null)
{
return "(null)";
}

var sb = new global::System.Text.StringBuilder();
_ = sb.Append('[');

bool first = true;
foreach (object e in enumerable)
{
if (!first)
{
_ = sb.Append(", ");
}

if (e == null)
{
_ = sb.Append("(null)");
}
else
{
if (e is global::System.IFormattable fmt)
{
_ = sb.Append(fmt.ToString(null, global::System.Globalization.CultureInfo.InvariantCulture));
}
else
{
_ = sb.Append(e);
}
}

first = false;
}

_ = sb.Append(']');

return sb.ToString();
}
}
10 changes: 5 additions & 5 deletions .../Baselines/TestWithOneParam.generated.txt → ...Baselines/TestWithTwoParams.generated.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,18 +3,18 @@

namespace Microsoft.Extensions.Logging.Generators.Tests.TestClasses
{
partial class TestWithOneParam
partial class TestWithTwoParams
{
[global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Extensions.Logging.Generators", "6.0.0.0")]
private static readonly global::System.Action<global::Microsoft.Extensions.Logging.ILogger, global::System.Int32, global::System.Exception?> __M0Callback =
global::Microsoft.Extensions.Logging.LoggerMessage.Define<global::System.Int32>(global::Microsoft.Extensions.Logging.LogLevel.Error, new global::Microsoft.Extensions.Logging.EventId(0, nameof(M0)), "M0 {A1}", true);
private static readonly global::System.Action<global::Microsoft.Extensions.Logging.ILogger, global::System.Int32, global::System.Collections.Generic.IEnumerable<global::System.Int32>, global::System.Exception?> __M0Callback =
global::Microsoft.Extensions.Logging.LoggerMessage.Define<global::System.Int32, global::System.Collections.Generic.IEnumerable<global::System.Int32>>(global::Microsoft.Extensions.Logging.LogLevel.Error, new global::Microsoft.Extensions.Logging.EventId(0, nameof(M0)), "M0 {a1} {a2}", true);

[global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Extensions.Logging.Generators", "6.0.0.0")]
public static partial void M0(global::Microsoft.Extensions.Logging.ILogger logger, global::System.Int32 a1)
public static partial void M0(global::Microsoft.Extensions.Logging.ILogger logger, global::System.Int32 a1, global::System.Collections.Generic.IEnumerable<global::System.Int32> a2)
{
if (logger.IsEnabled(global::Microsoft.Extensions.Logging.LogLevel.Error))
{
__M0Callback(logger, a1, null);
__M0Callback(logger, a1, a2, null);
}
}
}
Expand Down
12 changes: 6 additions & 6 deletions ...tests/Microsoft.Extensions.Logging.Generators.Tests/LoggerMessageGeneratorEmitterTests.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,18 +35,18 @@ public async Task TestEmitter()
}

[Fact]
public async Task TestBaseline_TestWithOneParam_Success()
public async Task TestBaseline_TestWithTwoParams_Success()
{
string testSourceCode = @"
namespace Microsoft.Extensions.Logging.Generators.Tests.TestClasses
{
internal static partial class TestWithOneParam
internal static partial class TestWithTwoParams
{
[LoggerMessage(EventId = 0, Level = LogLevel.Error, Message = ""M0 {A1}"")]
public static partial void M0(ILogger logger, int a1);
[LoggerMessage(EventId = 0, Level = LogLevel.Error, Message = ""M0 {a1} {a2}"")]
public static partial void M0(ILogger logger, int a1, System.Collections.Generic.IEnumerable<int> a2);
}
}";
await VerifyAgainstBaselineUsingFile("TestWithOneParam.generated.txt", testSourceCode);
await VerifyAgainstBaselineUsingFile("TestWithTwoParams.generated.txt", testSourceCode);
}

[Fact]
Expand All @@ -59,7 +59,7 @@ namespace Microsoft.Extensions.Logging.Generators.Tests.TestClasses
internal static partial class TestWithMoreThan6Params
{
[LoggerMessage(EventId = 8, Level = LogLevel.Error, Message = ""M9 {p1} {p2} {p3} {p4} {p5} {p6} {p7}"")]
public static partial void Method9(ILogger logger, int p1, int p2, int p3, int p4, int p5, int p6, int p7);
public static partial void Method9(ILogger logger, int p1, int p2, int p3, int p4, int p5, int p6, System.Collections.Generic.IEnumerable<int> p7);
}
}";
await VerifyAgainstBaselineUsingFile("TestWithMoreThan6Params.generated.txt", testSourceCode);
Expand Down

0 comments on commit 35d0022

Please sign in to comment.