Rule registration: "SonarTreeReportingContextBase.ReportIssue" assumes ShouldAnalyzeTree was called before

[martin-strecker-sonarsource]

There are two implementations of "ReportIssue":

SonarTreeReportingContextBase

sonar-dotnet/analyzers/src/SonarAnalyzer.Common/AnalysisContext/SonarReportingContextBase.cs

Lines 93 to 94 in 55c6cbe

	public void ReportIssue(Diagnostic diagnostic) =>
	ReportIssueCore(diagnostic);

SonarCompilationReportingContextBase

sonar-dotnet/analyzers/src/SonarAnalyzer.Common/AnalysisContext/SonarReportingContextBase.cs

Lines 104 to 110 in 55c6cbe

	public void ReportIssue(GeneratedCodeRecognizer generatedCodeRecognizer, Diagnostic diagnostic)
	{
	if (ShouldAnalyzeTree(diagnostic.Location.SourceTree, generatedCodeRecognizer))
	{
	ReportIssueCore(diagnostic);
	}
	}

These classes are derived from SonarTreeReportingContextBase

• SonarCodeBlockReportingContext
• SonarSemanticModelReportingContext
• SonarSyntaxNodeReportingContext
• SonarSyntaxTreeReportingContext

If the reporting happens through one of these contexts, ShouldAnalyzeTree is not checked. The reasoning is, that the check was done via "Execute" like in SonarAnalysisContext:

sonar-dotnet/analyzers/src/SonarAnalyzer.Common/AnalysisContext/SonarAnalysisContext.cs

Lines 117 to 119 in 55c6cbe

	public void RegisterSemanticModelAction(GeneratedCodeRecognizer generatedCodeRecognizer, Action<SonarSemanticModelReportingContext> action) =>
	analysisContext.RegisterSemanticModelAction(
	c => Execute<SonarSemanticModelReportingContext, SemanticModelAnalysisContext>(new(this, c), action, c.SemanticModel.SyntaxTree, generatedCodeRecognizer));

sonar-dotnet/analyzers/src/SonarAnalyzer.Common/AnalysisContext/SonarAnalysisContext.cs

Lines 143 to 157 in 55c6cbe

	private void Execute<TSonarContext, TRoslynContext>(TSonarContext context, Action<TSonarContext> action, SyntaxTree sourceTree, GeneratedCodeRecognizer generatedCodeRecognizer = null)
	where TSonarContext : SonarAnalysisContextBase<TRoslynContext>
	{
	// For each action registered on context we need to do some pre-processing before actually calling the rule.
	// First, we need to ensure the rule does apply to the current scope (main vs test source).
	// Second, we call an external delegate (set by legacy SonarLint for VS) to ensure the rule should be run (usually
	// the decision is made on based on whether the project contains the analyzer as NuGet).
	if (context.HasMatchingScope(SupportedDiagnostics)
	&& context.ShouldAnalyzeTree(sourceTree, generatedCodeRecognizer)
	&& LegacyIsRegisteredActionEnabled(SupportedDiagnostics, sourceTree)
	&& ShouldAnalyzeRazorFile(sourceTree))
	{
	action(context);
	}
	}

But in the other "Start" contexts this check is missing:

sonar-dotnet/analyzers/src/SonarAnalyzer.Common/AnalysisContext/SonarCodeBlockStartAnalysisContext.cs

Lines 34 to 35 in 55c6cbe

	public void RegisterNodeAction(Action<SonarSyntaxNodeReportingContext> action, params TSyntaxKind[] symbolKinds) =>
	Context.RegisterSyntaxNodeAction(x => action(new(AnalysisContext, x)), symbolKinds);

sonar-dotnet/analyzers/src/SonarAnalyzer.Common/AnalysisContext/SonarCompilationStartAnalysisContext.cs

Lines 33 to 40 in 55c6cbe

	public void RegisterSymbolAction(Action<SonarSymbolReportingContext> action, params SymbolKind[] symbolKinds) =>
	Context.RegisterSymbolAction(x => action(new(AnalysisContext, x)), symbolKinds);
	public void RegisterCompilationEndAction(Action<SonarCompilationReportingContext> action) =>
	Context.RegisterCompilationEndAction(x => action(new(AnalysisContext, x)));
	public void RegisterSemanticModelAction(Action<SonarSemanticModelReportingContext> action) =>
	Context.RegisterSemanticModelAction(x => action(new(AnalysisContext, x)));

.. and the new SymbolStartAnalysisContext of #8799

sonar-dotnet/analyzers/src/SonarAnalyzer.Common/AnalysisContext/SonarSymbolStartAnalysisContext.cs

Lines 34 to 53 in 9b7cab0

	public void RegisterCodeBlockAction(Action<SonarCodeBlockReportingContext> action) =>
	Context.RegisterCodeBlockAction(x => action(new(AnalysisContext, x)));
	public void RegisterCodeBlockStartAction<TLanguageKindEnum>(Action<SonarCodeBlockStartAnalysisContext<TLanguageKindEnum>> action) where TLanguageKindEnum : struct =>
	Context.RegisterCodeBlockStartAction<TLanguageKindEnum>(x => action(new(AnalysisContext, x)));
	public void RegisterOperationAction(Action<OperationAnalysisContext> action, ImmutableArray<OperationKind> operationKinds) =>
	throw new NotImplementedException("SonarOperationAnalysisContext wrapper type not implemented.");
	public void RegisterOperationBlockAction(Action<OperationBlockAnalysisContext> action) =>
	throw new NotImplementedException("SonarOperationBlockAnalysisContext wrapper type not implemented.");
	public void RegisterOperationBlockStartAction(Action<OperationBlockStartAnalysisContext> action) =>
	throw new NotImplementedException("SonarOperationBlockStartAnalysisContext wrapper type not implemented.");
	public void RegisterSymbolEndAction(Action<SonarSymbolReportingContext> action) =>
	Context.RegisterSymbolEndAction(x => action(new(AnalysisContext, x)));
	public void RegisterSyntaxNodeAction<TLanguageKindEnum>(Action<SonarSyntaxNodeReportingContext> action, params TLanguageKindEnum[] syntaxKinds) where TLanguageKindEnum : struct =>
	Context.RegisterSyntaxNodeAction(x => action(new(AnalysisContext, x)), syntaxKinds);

as a result, we raise in generated code in these registrations.

See also:

• Rule registration: SonarAnalysisContext: Forward all registrations to CompilationStart #8874
• Fix S6964 FP: Issues should not be raised in autogenerated code #9260
• Fix S6967 FP: Issues should not be raised in autogenerated code #9261