Merge pull request #6674 from smoogipoo/improve-source-generators

Replace compilation combination with semantic model check in source generators

Author: bdach

osu.Framework.SourceGeneration.Tests/Dependencies/DependencyInjectionSourceGeneratorTests.cs

@@ -2,6 +2,7 @@
 // See the LICENCE file in the repository root for full licence text.
 
 using System.Threading.Tasks;
+using Microsoft.CodeAnalysis;
 using Xunit;
 using VerifyCS = osu.Framework.SourceGeneration.Tests.Verifiers.CSharpSourceGeneratorVerifier<osu.Framework.SourceGeneration.Generators.Dependencies.DependencyInjectionSourceGenerator>;
 
@@ -47,5 +48,19 @@ public Task Check(string name)
 
             return VerifyCS.VerifyAsync(commonSourceFiles, sourceFiles, commonGeneratedFiles, generatedFiles);
         }
+
+        [Theory]
+        [InlineData("EmptyFile")]
+        public Task CheckDebugNoOutput(string name)
+        {
+            GetTestSources(name,
+                out (string filename, string content)[] commonSourceFiles,
+                out (string filename, string content)[] sourceFiles,
+                out _,
+                out _
+            );
+
+            return VerifyCS.VerifyAsync(commonSourceFiles, sourceFiles, [], [], OptimizationLevel.Debug);
+        }
     }
 }

osu.Framework.SourceGeneration.Tests/Verifiers/CSharpSourceGeneratorVerifier.cs

@@ -4,6 +4,7 @@
 using System.Text;
 using System.Threading;
 using System.Threading.Tasks;
+using Microsoft.CodeAnalysis;
 using Microsoft.CodeAnalysis.Text;
 using osu.Framework.SourceGeneration.Generators;
 
@@ -16,9 +17,10 @@ public static async Task VerifyAsync(
             (string filename, string content)[] commonSources,
             (string filename, string content)[] sources,
             (string filename, string content)[] commonGenerated,
-            (string filename, string content)[] generated)
+            (string filename, string content)[] generated,
+            OptimizationLevel optimizationLevel = OptimizationLevel.Release)
         {
-            var test = new Test();
+            var test = new Test(optimizationLevel);
 
             foreach (var s in commonSources)
                 test.TestState.Sources.Add((s.filename, SourceText.From(s.content, Encoding.UTF8)));

osu.Framework.SourceGeneration.Tests/Verifiers/CSharpSourceGeneratorVerifier_Test.cs

@@ -16,13 +16,20 @@ public partial class CSharpSourceGeneratorVerifier<TSourceGenerator>
     {
         public class Test : CSharpSourceGeneratorTest<EmptySourceGeneratorProvider, DefaultVerifier>
         {
+            private readonly OptimizationLevel optimizationLevel;
+
+            public Test(OptimizationLevel optimizationLevel = OptimizationLevel.Release)
+            {
+                this.optimizationLevel = optimizationLevel;
+            }
+
             public LanguageVersion LanguageVersion { get; set; } = LanguageVersion.Default;
 
             protected override IEnumerable<Type> GetSourceGenerators() => [typeof(TSourceGenerator)];
 
             protected override CompilationOptions CreateCompilationOptions()
             {
-                return base.CreateCompilationOptions().WithOptimizationLevel(OptimizationLevel.Release);
+                return base.CreateCompilationOptions().WithOptimizationLevel(optimizationLevel);
             }
 
             protected override ParseOptions CreateParseOptions()

osu.Framework.SourceGeneration/Generators/AbstractIncrementalGenerator.cs

@@ -20,11 +20,15 @@ public void Initialize(IncrementalGeneratorInitializationContext context)
             IncrementalValuesProvider<IncrementalSyntaxTarget> syntaxTargets =
                 context.SyntaxProvider.CreateSyntaxProvider(
                            (n, _) => isSyntaxTarget(n),
-                           (ctx, _) => returnWithEvent(new IncrementalSyntaxTarget((ClassDeclarationSyntax)ctx.Node, ctx.SemanticModel), EventDriver.OnSyntaxTargetCreated))
-                       .Select((t, _) => t.WithName())
-                       .Combine(context.CompilationProvider)
-                       .Where(c => c.Right.Options.OptimizationLevel == OptimizationLevel.Release)
-                       .Select((t, _) => t.Item1)
+                           (ctx, _) =>
+                           {
+                               if (ctx.SemanticModel.Compilation.Options.OptimizationLevel == OptimizationLevel.Debug)
+                                   return null;
+
+                               return returnWithEvent(new IncrementalSyntaxTarget((ClassDeclarationSyntax)ctx.Node, ctx.SemanticModel), EventDriver.OnSyntaxTargetCreated);
+                           })
+                       .Where(t => t != null)
+                       .Select((t, _) => t!.WithName())
                        .Select((t, _) => returnWithEvent(t.WithSemanticTarget(CreateSemanticTarget), EventDriver.OnSemanticTargetCreated));
 
             // Stage 2: Separate out the old and new syntax targets for the same class object.