Add a suppressor for CS8618 #11601

chsienki · 2025-03-10T21:18:23Z

Adds a suppressor for CS8618 when a component property has EditorRequired attached to it.

...oft.CodeAnalysis.Razor.Compiler/src/Analyzers/ComponentParameterNullableWarningSuppressor.cs

src/Compiler/Microsoft.CodeAnalysis.Razor.Compiler/src/Analyzers/AnalyzerResources.resx

...oft.CodeAnalysis.Razor.Compiler/src/Analyzers/ComponentParameterNullableWarningSuppressor.cs

- Use symbols rather than syntax - Only report if both parameter and editor required are on the property - Thread through the cancellation token

chsienki · 2025-03-11T17:48:55Z

Ok, updated to use symbols. Will work on adding some tests if we're happy with this approach.

333fred

Think this is in a good enough place to go for the tests.

333fred · 2025-03-11T18:50:51Z

...piler/Microsoft.CodeAnalysis.Razor.Compiler/src/Microsoft.CodeAnalysis.Razor.Compiler.csproj

@@ -1,4 +1,4 @@
-<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">


Looks like it was missing the BOM and this adds it back.

333fred · 2025-03-11T18:51:44Z

...oft.CodeAnalysis.Razor.Compiler/src/Analyzers/ComponentParameterNullableWarningSuppressor.cs

+                    if (attributes.Any(ad => SymbolEqualityComparer.Default.Equals(ad.AttributeClass, parameterSymbol))
+                        && attributes.Any(ad => SymbolEqualityComparer.Default.Equals(ad.AttributeClass, editorRequiredSymbol)))


Nit: cute syntax, but potentially loops through the list twice. Maybe a foreach would be better 🙂.

Updated. But also lol:

- remove XunitVerifiers and use default verifier instead (see https://github.com/dotnet/roslyn-sdk/blob/main/src/Microsoft.CodeAnalysis.Testing/README.md#obsolete-packages) - Remove uneeded .xunit package references

chsienki · 2025-03-11T22:30:03Z

...oft.NET.Sdk.Razor.SourceGenerators.Tests/ComponentParameterNullableWarningSuppressorTests.cs

+                using System;
+                using Microsoft.AspNetCore.Components;
+
+                public class MyComponent


This test makes me wonder. Should we be checking that these attributes are being used in something that implements IComponent?

I don't think that's required, consider this example:

abstract class B { [Parameter, EditorRequired] string Param { get; set; } } class C : B, IComponent;

B doesn't implement IComponent but can still be instantiated as a component through C.

IMO, for this type of edge case, I'd prefer to have false positives, rather than false negatives (iow, I think we should check for implementing IComponent). If we get feedback that this case is still being hit and causing pain, then we can take another look at it.

Yeah, lets keep it tightly scoped for now, and we can expand it later if we get feedback on it

Directory.Packages.props

...oft.NET.Sdk.Razor.SourceGenerators.Tests/ComponentParameterNullableWarningSuppressorTests.cs

jjonescz · 2025-03-12T09:36:44Z

...oft.NET.Sdk.Razor.SourceGenerators.Tests/ComponentParameterNullableWarningSuppressorTests.cs

+                using System;
+                using Microsoft.AspNetCore.Components;
+
+                public class MyComponent


I don't think that's required, consider this example:

abstract class B { [Parameter, EditorRequired] string Param { get; set; } } class C : B, IComponent;

B doesn't implement IComponent but can still be instantiated as a component through C.

...oft.CodeAnalysis.Razor.Compiler/src/Analyzers/ComponentParameterNullableWarningSuppressor.cs

jaredpar · 2025-03-12T17:25:48Z

...oft.CodeAnalysis.Razor.Compiler/src/Analyzers/ComponentParameterNullableWarningSuppressor.cs

+
+    public override void ReportSuppressions(SuppressionAnalysisContext context)
+    {
+        var editorRequiredSymbol = context.Compilation.GetTypeByMetadataName("Microsoft.AspNetCore.Components.EditorRequiredAttribute");


Couple Qs:

Should we bail out of the analyzer here if the value is null?

This will fail in the face of multiple definitions of this type. Not against that but want to make sure we clearly decided this.

Added an early return if we can't find the types, and a test to show behavior in the presence of duplicate attributes.

jaredpar · 2025-03-12T17:26:03Z

...oft.CodeAnalysis.Razor.Compiler/src/Analyzers/ComponentParameterNullableWarningSuppressor.cs

+    public override void ReportSuppressions(SuppressionAnalysisContext context)
+    {
+        var editorRequiredSymbol = context.Compilation.GetTypeByMetadataName("Microsoft.AspNetCore.Components.EditorRequiredAttribute");
+        var parameterSymbol = context.Compilation.GetTypeByMetadataName("Microsoft.AspNetCore.Components.ParameterAttribute");


Should we bail out if this is null?

Ensure the parameter is well defined

...oft.NET.Sdk.Razor.SourceGenerators.Tests/ComponentParameterNullableWarningSuppressorTests.cs

jjonescz · 2025-03-13T08:51:06Z

...oft.NET.Sdk.Razor.SourceGenerators.Tests/ComponentParameterNullableWarningSuppressorTests.cs

+                public class MyComponent : ComponentBase
+                {
+                    [Parameter, EditorRequired]
+                    public string MyParameter { get; set; }


Consider also testing string?.

jjonescz · 2025-03-13T08:53:13Z

...oft.NET.Sdk.Razor.SourceGenerators.Tests/ComponentParameterNullableWarningSuppressorTests.cs

+        }
+
+        [Theory]
+        [InlineData("init;")]


It looks like the runtime supports init parameters just fine, so perhaps we should suppress the warning for them as well?

...oft.NET.Sdk.Razor.SourceGenerators.Tests/ComponentParameterNullableWarningSuppressorTests.cs

Co-authored-by: Jan Jones <[email protected]>

Add a suppressor for CS8618

0bcc8e6

chsienki added the area-compiler Umbrella for all compiler issues label Mar 10, 2025

chsienki requested a review from a team as a code owner March 10, 2025 21:18

333fred reviewed Mar 10, 2025

View reviewed changes

...oft.CodeAnalysis.Razor.Compiler/src/Analyzers/ComponentParameterNullableWarningSuppressor.cs Outdated Show resolved Hide resolved

jjonescz reviewed Mar 11, 2025

View reviewed changes

...oft.CodeAnalysis.Razor.Compiler/src/Analyzers/ComponentParameterNullableWarningSuppressor.cs Outdated Show resolved Hide resolved

PR Feedback:

31485a7

- Use symbols rather than syntax - Only report if both parameter and editor required are on the property - Thread through the cancellation token

333fred reviewed Mar 11, 2025

View reviewed changes

chsienki added 5 commits March 11, 2025 15:22

Update to latest ms.cs.analyzer.testing:

8b1f80a

- remove XunitVerifiers and use default verifier instead (see https://github.com/dotnet/roslyn-sdk/blob/main/src/Microsoft.CodeAnalysis.Testing/README.md#obsolete-packages) - Remove uneeded .xunit package references

Add suppressor tests

827a89b

Extract id into a shared class

bfa08d7

Don't iterate the attributes twice

f7dded1

Add comment about what we're suppressing

fbbafbb

chsienki commented Mar 11, 2025

View reviewed changes

jjonescz reviewed Mar 12, 2025

View reviewed changes

Remove NoWarn

0ec81ad

jaredpar reviewed Mar 12, 2025

View reviewed changes

chsienki added 3 commits March 12, 2025 10:48

Use basic.ref.assemblies for aspnetcore assemblies

d2c4580

Return early if we cant find symbols

c3869e3

Ensure the parameter is well defined

Add more tests

864cbbd

jjonescz reviewed Mar 13, 2025

View reviewed changes

Apply suggestions from code review

c2d51aa

Co-authored-by: Jan Jones <[email protected]>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add a suppressor for CS8618 #11601

Add a suppressor for CS8618 #11601

chsienki commented Mar 10, 2025

chsienki commented Mar 11, 2025

333fred left a comment

333fred Mar 11, 2025

chsienki Mar 11, 2025

333fred Mar 11, 2025

chsienki Mar 11, 2025

chsienki Mar 11, 2025

jjonescz Mar 12, 2025

333fred Mar 13, 2025

chsienki Mar 13, 2025

jjonescz Mar 12, 2025

jaredpar Mar 12, 2025

chsienki Mar 12, 2025

jaredpar Mar 12, 2025

jjonescz Mar 13, 2025

jjonescz Mar 13, 2025

		@@ -1,4 +1,4 @@
		<Project Sdk="Microsoft.NET.Sdk">
		<Project Sdk="Microsoft.NET.Sdk">

		if (attributes.Any(ad => SymbolEqualityComparer.Default.Equals(ad.AttributeClass, parameterSymbol))
		&& attributes.Any(ad => SymbolEqualityComparer.Default.Equals(ad.AttributeClass, editorRequiredSymbol)))

Add a suppressor for CS8618 #11601

Are you sure you want to change the base?

Add a suppressor for CS8618 #11601

Conversation

chsienki commented Mar 10, 2025

chsienki commented Mar 11, 2025

333fred left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment