Two bugfixes for logging generator #51963
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -16,11 +16,12 @@ internal class Emitter | |
| private const int MaxLoggerMessageDefineArguments = 6; | ||
| private const int DefaultStringBuilderCapacity = 1024; | ||
|
|
||
| private static readonly string s_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) | ||
| { | ||
|
|
@@ -34,6 +35,7 @@ public string Emit(IReadOnlyList<LoggerClass> logClasses, CancellationToken canc | |
| GenType(lc); | ||
| } | ||
|
|
||
| GenEnumerationHelper(); | ||
| return _builder.ToString(); | ||
| } | ||
|
|
||
|
|
@@ -47,10 +49,10 @@ private static bool UseLoggerMessageDefine(LoggerMethod lm) | |
| if (result) | ||
| { | ||
| // make sure the order of the templates matches the order of the logging method parameter | ||
| for (int i = 0; i < lm.TemplateList.Count; i++) | ||
| { | ||
| string t = lm.TemplateList[i]; | ||
| if (!t.Equals(lm.TemplateParameters[i].Name, StringComparison.OrdinalIgnoreCase)) | ||
| { | ||
| // order doesn't match, can't use LoggerMessage.Define | ||
| return false; | ||
|
|
@@ -84,8 +86,6 @@ partial class {lc.Name} {lc.Constraints} | |
| GenLogMethod(lm); | ||
| } | ||
|
|
||
| _builder.Append($@" | ||
| }}"); | ||
|
|
||
|
|
@@ -99,7 +99,7 @@ partial class {lc.Name} {lc.Constraints} | |
| private void GenStruct(LoggerMethod lm) | ||
| { | ||
| _builder.AppendLine($@" | ||
| [{s_generatedCodeAttribute}] | ||
| private readonly struct __{lm.Name}Struct : global::System.Collections.Generic.IReadOnlyList<global::System.Collections.Generic.KeyValuePair<string, object?>> | ||
| {{"); | ||
| GenFields(lm); | ||
|
|
@@ -193,7 +193,9 @@ private void GenVariableAssignments(LoggerMethod lm) | |
| if (lm.TemplateParameters[index].IsEnumerable) | ||
| { | ||
| _builder.AppendLine($" var {t.Key} = " | ||
| + $"global::__LoggerMessageGenerator.Enumerate((global::System.Collections.IEnumerable ?)this._{lm.TemplateParameters[index].Name});"); | ||
|
|
||
| _needEnumerationHelper = true; | ||
| } | ||
| else | ||
| { | ||
|
|
@@ -237,7 +239,7 @@ private void GenDefineTypes(LoggerMethod lm, bool brackets) | |
| } | ||
| if (brackets) | ||
| { | ||
| _builder.Append('<'); | ||
| } | ||
|
|
||
| bool firstItem = true; | ||
|
|
@@ -257,7 +259,7 @@ private void GenDefineTypes(LoggerMethod lm, bool brackets) | |
|
|
||
| if (brackets) | ||
| { | ||
| _builder.Append('>'); | ||
| } | ||
| else | ||
| { | ||
|
|
@@ -322,15 +324,15 @@ private void GenHolder(LoggerMethod lm) | |
| private void GenLogMethod(LoggerMethod lm) | ||
| { | ||
| string level = GetLogLevel(lm); | ||
| 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); | ||
|
|
||
| if (UseLoggerMessageDefine(lm)) | ||
| { | ||
| _builder.Append($@" | ||
| [{s_generatedCodeAttribute}] | ||
| private static readonly global::System.Action<global::Microsoft.Extensions.Logging.ILogger, "); | ||
|
|
||
| GenDefineTypes(lm, brackets: false); | ||
|
|
@@ -345,7 +347,7 @@ private void GenLogMethod(LoggerMethod lm) | |
| } | ||
|
|
||
| _builder.Append($@" | ||
| [{s_generatedCodeAttribute}] | ||
| {lm.Modifiers} void {lm.Name}({extension}"); | ||
|
|
||
| GenParameters(lm); | ||
|
|
@@ -443,63 +445,56 @@ static string GetLogLevel(LoggerMethod lm) | |
| } | ||
| } | ||
|
|
||
| private void GenEnumerationHelper() | ||
| { | ||
| if (_needEnumerationHelper) | ||
| { | ||
| _builder.Append($@" | ||
| [{s_generatedCodeAttribute}] | ||
| internal static class __LoggerMessageGenerator | ||
|
There was a problem hiding this comment. Just thinking out loud here, but I almost wonder if this deserves to be a public API in our library instead of generating this code into the user's project. I started by thinking "is putting this in the global namespace the right thing to do?" And then that quickly led to "why are we generating this code when it never changes based on the user's types?" There was a problem hiding this comment. In the very first API review proposal (Refer to comment #36022 (comment)), we proposed this static The consensus back then was for such cases to just generate them if/when needed. |
||
| {{ | ||
| 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(); | ||
| }} | ||
| }}"); | ||
| } | ||
| } | ||
| } | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
The enumeration helper is either generated (only once), or not at all into
__LoggerMessageGenerator