Skip to content

Logging Generator Parser - Code cleanup PR feedback #52018

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
merged 3 commits into from
Apr 29, 2021
Merged

Logging Generator Parser - Code cleanup PR feedback #52018

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
0fbcf61
Parser PR feedback from preview 4
maryamariyan Apr 28, 2021
a061b39
Update src/libraries/Microsoft.Extensions.Logging/gen/LoggerMessageGe…
maryamariyan Apr 28, 2021
28d1ee3
Move up semantic model declaration
maryamariyan Apr 29, 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
169 changes: 58 additions & 111 deletions src/libraries/Microsoft.Extensions.Logging/gen/LoggerMessageGenerator.Parser.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
// The .NET Foundation licenses this file to you under the MIT license.

using System;
using System.Diagnostics;
using System.Collections.Generic;
using System.Linq;
using System.Threading;
Expand Down Expand Up @@ -61,19 +62,8 @@ public IReadOnlyList<LoggerClass> GetLogClasses(IEnumerable<ClassDeclarationSynt
return Array.Empty<LoggerClass>();
}

INamedTypeSymbol enumerableSymbol = _compilation.GetTypeByMetadataName("System.Collections.IEnumerable");
if (enumerableSymbol == null)
{
Diag(DiagnosticDescriptors.MissingRequiredType, null, "System.Collections.IEnumerable");
return Array.Empty<LoggerClass>();
}

INamedTypeSymbol stringSymbol = _compilation.GetTypeByMetadataName("System.String");
if (stringSymbol == null)
{
Diag(DiagnosticDescriptors.MissingRequiredType, null, "System.String");
return Array.Empty<LoggerClass>();
}
INamedTypeSymbol enumerableSymbol = _compilation.GetSpecialType(SpecialType.System_Collections_IEnumerable);
INamedTypeSymbol stringSymbol = _compilation.GetSpecialType(SpecialType.System_String);

var results = new List<LoggerClass>();
var ids = new HashSet<int>();
Expand Down Expand Up @@ -102,29 +92,29 @@ public IReadOnlyList<LoggerClass> GetLogClasses(IEnumerable<ClassDeclarationSynt
continue;
}

sm ??= _compilation.GetSemanticModel(classDec.SyntaxTree);

foreach (AttributeListSyntax mal in method.AttributeLists)
{
foreach (AttributeSyntax ma in mal.Attributes)
{
sm ??= _compilation.GetSemanticModel(classDec.SyntaxTree);

IMethodSymbol attrCtorSymbol = sm.GetSymbolInfo(ma, _cancellationToken).Symbol as IMethodSymbol;
if (attrCtorSymbol == null || !loggerMessageAttribute.Equals(attrCtorSymbol.ContainingType, SymbolEqualityComparer.Default))
{
// badly formed attribute definition, or not the right attribute
continue;
}

(int eventId, int? level, string? message, string? eventName) = ExtractAttributeValues(ma.ArgumentList!, sm);
(int eventId, int? level, string message, string? eventName) = ExtractAttributeValues(ma.ArgumentList!, sm);

IMethodSymbol? methodSymbol = sm.GetDeclaredSymbol(method, _cancellationToken);
if (methodSymbol != null)
{
var lm = new LoggerMethod
{
Name = method.Identifier.ToString(),
Name = methodSymbol.Name,
Level = level,
Message = message ?? string.Empty,
Message = message,
EventId = eventId,
EventName = eventName,
IsExtensionMethod = methodSymbol.IsExtensionMethod,
Expand All @@ -142,7 +132,7 @@ public IReadOnlyList<LoggerClass> GetLogClasses(IEnumerable<ClassDeclarationSynt
keepMethod = false;
}

if (sm.GetTypeInfo(method.ReturnType!).Type!.SpecialType != SpecialType.System_Void)
if (!methodSymbol.ReturnsVoid)
{
// logging methods must return void
Diag(DiagnosticDescriptors.LoggingMethodMustReturnVoid, method.ReturnType.GetLocation());
Expand Down Expand Up @@ -208,38 +198,36 @@ public IReadOnlyList<LoggerClass> GetLogClasses(IEnumerable<ClassDeclarationSynt
bool foundLogger = false;
bool foundException = false;
bool foundLogLevel = level != null;
foreach (ParameterSyntax p in method.ParameterList.Parameters)
foreach (IParameterSymbol paramSymbol in methodSymbol.Parameters)
{
string paramName = p.Identifier.ToString();
string paramName = paramSymbol.Name;
if (string.IsNullOrWhiteSpace(paramName))
{
// semantic problem, just bail quietly
keepMethod = false;
break;
}

IParameterSymbol? declSymbol = sm.GetDeclaredSymbol(p);
ITypeSymbol paramSymbol = declSymbol!.Type;
if (paramSymbol is IErrorTypeSymbol)
ITypeSymbol paramTypeSymbol = paramSymbol!.Type;
if (paramTypeSymbol is IErrorTypeSymbol)
{
// semantic problem, just bail quietly
keepMethod = false;
break;
}

IParameterSymbol declaredType = sm.GetDeclaredSymbol(p);
string typeName = declaredType!.Type.ToDisplayString(
string typeName = paramTypeSymbol.ToDisplayString(
SymbolDisplayFormat.FullyQualifiedFormat.WithMiscellaneousOptions(
SymbolDisplayMiscellaneousOptions.IncludeNullableReferenceTypeModifier));

var lp = new LoggerParameter
{
Name = paramName,
Type = typeName,
IsLogger = !foundLogger && IsBaseOrIdentity(paramSymbol!, loggerSymbol),
IsException = !foundException && IsBaseOrIdentity(paramSymbol!, exceptionSymbol),
IsLogLevel = !foundLogLevel && IsBaseOrIdentity(paramSymbol!, logLevelSymbol),
IsEnumerable = IsBaseOrIdentity(paramSymbol!, enumerableSymbol) && !IsBaseOrIdentity(paramSymbol!, stringSymbol),
IsLogger = !foundLogger && IsBaseOrIdentity(paramTypeSymbol!, loggerSymbol),
IsException = !foundException && IsBaseOrIdentity(paramTypeSymbol!, exceptionSymbol),
IsLogLevel = !foundLogLevel && IsBaseOrIdentity(paramTypeSymbol!, logLevelSymbol),
IsEnumerable = IsBaseOrIdentity(paramTypeSymbol!, enumerableSymbol) && !IsBaseOrIdentity(paramTypeSymbol!, stringSymbol),
};

foundLogger |= lp.IsLogger;
Expand All @@ -248,30 +236,30 @@ public IReadOnlyList<LoggerClass> GetLogClasses(IEnumerable<ClassDeclarationSynt

if (lp.IsLogger && lm.TemplateMap.ContainsKey(paramName))
{
Diag(DiagnosticDescriptors.ShouldntMentionLoggerInMessage, p.Identifier.GetLocation(), paramName);
Diag(DiagnosticDescriptors.ShouldntMentionLoggerInMessage, paramSymbol.Locations[0], paramName);
}
else if (lp.IsException && lm.TemplateMap.ContainsKey(paramName))
{
Diag(DiagnosticDescriptors.ShouldntMentionExceptionInMessage, p.Identifier.GetLocation(), paramName);
Diag(DiagnosticDescriptors.ShouldntMentionExceptionInMessage, paramSymbol.Locations[0], paramName);
}
else if (lp.IsLogLevel && lm.TemplateMap.ContainsKey(paramName))
{
Diag(DiagnosticDescriptors.ShouldntMentionLogLevelInMessage, p.Identifier.GetLocation(), paramName);
Diag(DiagnosticDescriptors.ShouldntMentionLogLevelInMessage, paramSymbol.Locations[0], paramName);
}
else if (lp.IsLogLevel && level != null && !lm.TemplateMap.ContainsKey(paramName))
{
Diag(DiagnosticDescriptors.ArgumentHasNoCorrespondingTemplate, p.Identifier.GetLocation(), paramName);
Diag(DiagnosticDescriptors.ArgumentHasNoCorrespondingTemplate, paramSymbol.Locations[0], paramName);
}
else if (lp.IsTemplateParameter && !lm.TemplateMap.ContainsKey(paramName))
{
Diag(DiagnosticDescriptors.ArgumentHasNoCorrespondingTemplate, p.Identifier.GetLocation(), paramName);
Diag(DiagnosticDescriptors.ArgumentHasNoCorrespondingTemplate, paramSymbol.Locations[0], paramName);
}

if (paramName[0] == '_')
{
// can't have logging method parameter names that start with _ since that can lead to conflicting symbol names
// because all generated symbols start with _
Diag(DiagnosticDescriptors.InvalidLoggingMethodParameterName, p.Identifier.GetLocation());
Diag(DiagnosticDescriptors.InvalidLoggingMethodParameterName, paramSymbol.Locations[0]);
}

lm.AllParameters.Add(lp);
Expand Down Expand Up @@ -427,88 +415,32 @@ public IReadOnlyList<LoggerClass> GetLogClasses(IEnumerable<ClassDeclarationSynt
return (loggerField, false);
}

private (int eventId, int? level, string? message, string? eventName) ExtractAttributeValues(AttributeArgumentListSyntax args, SemanticModel sm)
private (int eventId, int? level, string message, string? eventName) ExtractAttributeValues(AttributeArgumentListSyntax args, SemanticModel sm)
{
// two constructor arg shapes:
//
// (eventId, level, message)
// (eventId, message)

int eventId = 0;
int? level = null;
string? eventName = null;
string? message = null;
int numPositional = 0;
string message = string.Empty;
foreach (AttributeArgumentSyntax a in args.Arguments)
{
if (a.NameEquals != null)
{
switch (a.NameEquals.Name.ToString())
{
case "EventId":
eventId = (int)sm.GetConstantValue(a.Expression, _cancellationToken).Value!;
break;
case "EventName":
eventName = sm.GetConstantValue(a.Expression, _cancellationToken).ToString();
break;
case "Level":
level = (int)sm.GetConstantValue(a.Expression, _cancellationToken).Value!;
break;
case "Message":
message = sm.GetConstantValue(a.Expression, _cancellationToken).ToString();
break;
}
}
else if (a.NameColon != null)
// argument syntax takes parameters. e.g. EventId = 0
Debug.Assert(a.NameEquals != null);
switch (a.NameEquals.Name.ToString())
{
switch (a.NameColon.Name.ToString())
{
case "eventId":
eventId = (int)sm.GetConstantValue(a.Expression, _cancellationToken).Value!;
break;

case "level":
level = (int)sm.GetConstantValue(a.Expression, _cancellationToken).Value!;
break;

case "message":
message = sm.GetConstantValue(a.Expression, _cancellationToken).ToString();
break;
}
}
else
{
switch (numPositional)
{
// event id
case 0:
eventId = (int)sm.GetConstantValue(a.Expression, _cancellationToken).Value!;
break;

// log level or message
case 1:
object o = sm.GetConstantValue(a.Expression, _cancellationToken).Value!;
if (o is int l)
{
level = l;
}
else
{
message = sm.GetConstantValue(a.Expression, _cancellationToken).ToString();
}

break;

// message
case 2:
message = sm.GetConstantValue(a.Expression, _cancellationToken).ToString();
break;
}

numPositional++;
case "EventId":
eventId = (int)sm.GetConstantValue(a.Expression, _cancellationToken).Value!;
break;
case "EventName":
eventName = sm.GetConstantValue(a.Expression, _cancellationToken).ToString();
break;
case "Level":
level = (int)sm.GetConstantValue(a.Expression, _cancellationToken).Value!;
break;
case "Message":
message = sm.GetConstantValue(a.Expression, _cancellationToken).ToString();
break;
}
}

return (eventId, level, message, eventName);
}

Expand All @@ -528,7 +460,7 @@ private bool IsBaseOrIdentity(ITypeSymbol source, ITypeSymbol dest)
/// <summary>
/// Finds the template arguments contained in the message string.
/// </summary>
private static void ExtractTemplates(string? message, IDictionary<string, string> templateMap, IList<string> templateList)
private static void ExtractTemplates(string? message, IDictionary<string, string> templateMap, ICollection<string> templateList)
{
if (string.IsNullOrEmpty(message))
{
Expand Down Expand Up @@ -613,6 +545,21 @@ private static int FindIndexOfAny(string message, char[] chars, int startIndex,
int findIndex = message.IndexOfAny(chars, startIndex, endIndex - startIndex);
return findIndex == -1 ? endIndex : findIndex;
}

private string GetStringExpression(SemanticModel sm, SyntaxNode expr)
{
Optional<object?> optional = sm.GetConstantValue(expr, _cancellationToken);
if (optional.HasValue)
{
object o = optional.Value;
if (o != null)
{
return o.ToString();
}
}

return string.Empty;
}
}

/// <summary>
Expand Down Expand Up @@ -642,7 +589,7 @@ internal class LoggerMethod
public string? EventName;
public bool IsExtensionMethod;
public string Modifiers = string.Empty;
public string LoggerField;
public string LoggerField = string.Empty;
}

/// <summary>
Expand Down
Loading