Roslyn analyzer throws error AD0001 NullReferenceException

[akoeplinger]

Build

https://dev.azure.com/dnceng-public/cbb18261-c48f-4abb-8651-8cdcb5474649/_build/results?buildId=733128

Build leg reported

VMR Vertical Build / Ubuntu2404_DevVersions_x64 / Build

Pull Request

dotnet/sdk#42019

Known issue core information

Fill out the known issue JSON section by following the step by step documentation on how to create a known issue

 {
    "ErrorMessage" : "",
    "BuildRetry": true,
    "ErrorPattern": "error AD0001: Analyzer.*threw an exception of type 'System.NullReferenceException'",
    "ExcludeConsoleLog": false
 }

@dotnet/dnceng

Release Note Category

• Feature changes/additions
• Bug fixes
• Internal Infrastructure Improvements

Release Note Description

Additional information about the issue reported

No response

Known issue validation

Build: 🔎 https://dev.azure.com/dnceng-public/public/_build/results?buildId=733128
Error message validated: [error AD0001: Analyzer.*threw an exception of type 'System.NullReferenceException']
Result validation: ✅ Known issue matched with the provided build.
Validation performed at: 7/8/2024 7:22:28 PM UTC

Report

Build	Definition	Step Name	Console log	Pull Request
1055946	dotnet/sdk	🟣 Build	Log	dotnet/sdk#49125
1053713	dotnet/sdk	🟣 Build	Log	dotnet/sdk#49080
1053412	dotnet/sdk	🟣 Build	Log	dotnet/sdk#49125
1053262	dotnet/sdk	🟣 Build	Log	dotnet/sdk#49125
1053245	dotnet/sdk	🟣 Build	Log	dotnet/sdk#49080
1052680	dotnet/sdk	🟣 Build	Log	dotnet/sdk#49080
1052268	dotnet/sdk	🟣 Build	Log	dotnet/sdk#49125
1051575	dotnet/sdk	🟣 Build	Log	dotnet/sdk#49080
1051391	dotnet/sdk	🟣 Build	Log	dotnet/sdk#49125
1050541	dotnet/sdk	🟣 Build	Log	dotnet/sdk#49125
1050521	dotnet/sdk	🟣 Build	Log	dotnet/sdk#49080

Summary

24-Hour Hit Count	7-Day Hit Count	1-Month Count
0	0	11

[ViktorHofer]

Hmm... This error showed up in dotnet/sdk#36807 as well:

CSC : error AD0001: Analyzer 'Microsoft.NetCore.CSharp.Analyzers.Runtime.CSharpDetectPreviewFeatureAnalyzer' threw an exception of type 'System.NullReferenceException' with message 'Object reference not set to an instance of an object.'. [/vmr/src/efcore/src/EFCore/EFCore.csproj]

But I don't see it in the above table. Are we missing data?

[akoeplinger]

It's now in the table, probably just took a bit.

[ViktorHofer]

Interesting, I was under the impression that this only affects VMR builds but apparently this is more widespread.

[akoeplinger]

Yeah. I queried Kusto and we hit this 133 times over the last 60 days just in build logs.

[ericstj]

Should we add "BuildRetry": false to the known issue pattern here? I haven't used that feature but it may help.

[akoeplinger]

Yeah. Done.

[jaredpar]

Not sure what is going on but a significant chunk of the hits here seem to be false positives. Just spent 10 minutes digging through builds and can't see the error on 75% of them.

[jaredpar]

Many of the builds are attributed to dotnet-runtime when it's actually dotnet-runtime-perf. Also the results look like this ...

If the compiler is indeed throwing there it's very hard to dig through to the failure.

[jaredpar]

Cross posting the analysis from the linked bug on roslyn-analyzers

This is the stack of the NullReferenceException in at least one case:

System.NullReferenceException: Object reference not set to an instance of an object.
at System.Collections.Concurrent.ConcurrentDictionary`2.TryRemoveInternal(TKey key, TValue& value, Boolean matchValue, TValue oldValue)
at Microsoft.CodeQuality.Analyzers.Maintainability.AvoidUnusedPrivateFieldsAnalyzer.<>c__DisplayClass5_0.<Initialize>b__2(OperationAnalysisContext operationContext)
at Microsoft.CodeAnalysis.Diagnostics.AnalyzerExecutor.ExecuteAndCatchIfThrows_NoLock[TArg](DiagnosticAnalyzer analyzer, Action`1 analyze, TArg argument, Nullable`1 info, CancellationToken cancellationToken)

That almost certainly represents this line in the roslyn analyzers code:

IFieldSymbol field = ((IFieldReferenceOperation)operationContext.Operation).Field;
if (field.DeclaredAccessibility == Accessibility.Private)
{
    referencedPrivateFields.TryAdd(field, default);
    // Error is here. 
    maybeUnreferencedPrivateFields.TryRemove(field, out _);
}

Both values here are non-null:

• maybeUnreferencedPrivateFields: is single assign and initialized to non-null at declaration
• field: is used above this line several times without null reffing.

That seems like a runtime bug.

[jaredpar]

@akoeplinger, @ericstj, @ViktorHofer at least the variation I'm seeing above appears to be a runtime bug. Do we want to use this issue to track that or file a new one?

[ericstj]

I think a new one since the pattern observed here (single log statement with NRE) can't necessarily tie it to the single analyzer. Do you have a dump to help triage the runtime issue or is it just based on the callstack?