Add LoggingGenerator

[maryamariyan]

Fixes #36022

More Info: https://github.com/dotnet/designs/blob/main/accepted/2021/logging-generator.md

---

CI Health:

• wasm console log (link):

Stack trace

browser: Console websocket connected.
Arguments: --run,WasmTestRunner.dll,Microsoft.Extensions.Logging.Generators.Tests.dll,-notrait,category=IgnoreForCI,-notrait,category=OuterLoop,-notrait,category=failing
MONO_WASM: Initializing mono runtime
MONO_WASM: ICU data archive(s) loaded, disabling invariant mode
mono_wasm_runtime_ready
Initializing.....
System.AggregateException: One or more errors occurred. (Could not load file or assembly 'Microsoft.CodeAnalysis, Version=3.8.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35' or one of its dependencies.)
 ---> System.IO.FileNotFoundException: Could not load file or assembly 'Microsoft.CodeAnalysis, Version=3.8.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35' or one of its dependencies.
File name: 'Microsoft.CodeAnalysis, Version=3.8.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35'
   at System.Reflection.MonoMethodInfo.GetMethodInfo(IntPtr handle)
   at System.Reflection.RuntimeMethodInfo.GetPseudoCustomAttributesData()
   at System.Reflection.CustomAttribute.GetPseudoCustomAttributesData(ICustomAttributeProvider obj, Type attributeType)
   at System.Reflection.CustomAttribute.GetCustomAttributesDataBase(ICustomAttributeProvider obj, Type attributeType, Boolean inheritedOnly)
   at System.Reflection.CustomAttribute.GetCustomAttributesData(ICustomAttributeProvider obj, Boolean inherit)
   at System.Reflection.CustomAttributeData.GetCustomAttributes(MemberInfo target)
   at System.Reflection.RuntimeMethodInfo.GetCustomAttributesData()
   at System.Reflection.MemberInfo.get_CustomAttributes()
   at Xunit.Sdk.ReflectionMethodInfo.GetCustomAttributes(MethodInfo method, Type attributeType, AttributeUsageAttribute attributeUsage)
   at Xunit.Sdk.ReflectionMethodInfo.GetCustomAttributes(MethodInfo method, String assemblyQualifiedAttributeTypeName)
   at Xunit.Sdk.ReflectionMethodInfo.GetCustomAttributes(String assemblyQualifiedAttributeTypeName)
   at ReflectionAbstractionExtensions.GetCustomAttributes(IMethodInfo methodInfo, Type attributeType)
   at Xunit.Sdk.XunitTestFrameworkDiscoverer.FindTestsForMethod(ITestMethod testMethod, Boolean includeSourceInformation, IMessageBus messageBus, ITestFrameworkDiscoveryOptions discoveryOptions)
   at Xunit.Sdk.XunitTestFrameworkDiscoverer.FindTestsForType(ITestClass testClass, Boolean includeSourceInformation, IMessageBus messageBus, ITestFrameworkDiscoveryOptions discoveryOptions)
   at Microsoft.DotNet.XHarness.TestRunners.Xunit.ThreadlessXunitDiscoverer.FindWithoutThreads(Boolean includeSourceInformation, IMessageSink discoveryMessageSink, ITestFrameworkDiscoveryOptions discoveryOptions)
   at Microsoft.DotNet.XHarness.TestRunners.Xunit.ThreadlessXunitTestRunner.Run(String assemblyFileName, Boolean printXml, XunitFilters filters)
   at Microsoft.DotNet.XHarness.TestRunners.Xunit.WasmApplicationEntryPoint.Run()
   at SimpleWasmTestRunner.Main(String[] args)
   --- End of inner exception stack trace ---
Discovering: Microsoft.Extensions.Logging.Generators.Tests.dll (method display = ClassAndMethod, method display options = None)
WASM EXIT 1

Workaround: Exclude gen test project when TargetsMono set to true

TODO:

• Add a set of baseline files to test against (two or three use cases) (Add LoggingGenerator #51064 (comment))
• Update Emitter/Parser with feedback
• Handle case: can't have a log level in both the attribute and as a logging method parameter (Add LoggingGenerator #51064 (comment))

Separate from this PR:

• File a dotnet/runtime issue to request enabling unit test coverage report for generator projects
• File a dotnet/roslyn issue to help with ensuring users get a compile-time error if the source generator doesn't run (Add LoggingGenerator #51064 (comment))
• Understand why we get CLSCompliant errors (ended up setting CLSCompliant false on the generator project) (Add LoggingGenerator #51064 (comment))
• Consider enabling generator tests for Mobile and Browser platforms (Add LoggingGenerator #51064 (comment))
• Consider setting a DARC dependency to roslyn for Microsoft.CodeAnalysis.CSharp.Workspaces dependency (Add LoggingGenerator #51064 (comment))

Next PR

• Add diagnostic when: can't have the same template with different casing, (Add LoggingGenerator #51064 (comment))
• Add diagnostic when: can't have malformed format strings (like dangling {, etc) (Add LoggingGenerator #51064 (comment))
• Remove support for generating more than 6 arguments (refer to Compile-time source generation for structured log messages designs#195 (comment)) and would involve adding another diagnostic here. (Added baseline TestBaseline_TestWithMoreThan6Params_Success to illustrate this use case)
• context.AddSource(nameof(Generator), SourceText.From(result, Encoding.UTF8)); // replace nameof(Generator) with "LoggerMessage"

[eerhardt]

Can we use string.IndexOfAny?

[maryamariyan]

Good idea, I could try on another PR or post preview 4.

[maryamariyan]

reviewers

can I get a sign off on this PR if your blocking feedback is addressed?

cc @eerhardt @tarekgh @ericstj @safern

I will have a follow up to reduce source generator support (not allow source generation for larger than 6 arguments, etc.) but that would not drastically change all the changes reviewed here.

[eerhardt]

I think this is great work that will benefit our customers. Let's get this feature in.

[ericstj]

Woo hoo! Glad to see this in.
Test failures are known: #51346 and #51372 (thank you @eerhardt for filing these)

[GrabYourPitchforks]

@maryamariyan I generated the fwlinks and have pointed all of them to this issue for now. Once you create proper docs pages for all the newly introduced analyzer rules, feel free to change the fwlinks yourself (you should have write permission), or ping me and I can assist with changing them. Thanks!