Exception from the ReturnStructPartialActivePatternAnalyzer analyzer in the latest Ionide when using the transparent compiler

[Numpsy]

Describe the bug
Whilst running Ionide with Verbose logging enabled to test something else, I noticed this in the log output when it ran the latest version of the analyzers on my project:

[09:42:03.456 ERR] [Analyzers] Analyzer ReturnStructPartialActivePatternAnalyzer errored while processing s:\BJKCTitDev\DocLabellerMicro\DocLabellerMicro\src\DocLabellerMicro\Types.fs: ProjectOptions are not available. This is expected when using FSharpChecker with useTransparentCompiler=true.
System.Exception: ProjectOptions are not available. This is expected when using FSharpChecker with useTransparentCompiler=true.
   at FSharp.Compiler.CodeAnalysis.FSharpProjectContext.get_ProjectOptions() in D:\a\_work\1\s\src\Compiler\Service\FSharpCheckerResults.fs:line 3333
   at Ionide.Analyzers.Performance.ReturnStructPartialActivePatternAnalyzer.runIfLanguageFeatureIsSupported(ISourceText sourceText, ParsedInput parsedInput, FSharpCheckFileResults checkResults) in /_//src/Ionide.Analyzers/Performance/ReturnStructPartialActivePatternAnalyzer.fs:line 215
   at Ionide.Analyzers.Performance.ReturnStructPartialActivePatternAnalyzer.returnStructPartialActivePatternEditorAnalyzer@238.Invoke(Unit unitVar) in /_//src/Ionide.Analyzers/Performance/ReturnStructPartialActivePatternAnalyzer.fs:line 238
   at Microsoft.FSharp.Control.AsyncPrimitives.CallThenInvoke[T,TResult](AsyncActivation`1 ctxt, TResult result1, FSharpFunc`2 part2) in D:\a\_work\1\s\src\FSharp.Core\async.fs:line 509
   at Microsoft.FSharp.Control.Trampoline.Execute(FSharpFunc`2 firstAction) in D:\a\_work\1\s\src\FSharp.Core\async.fs:line 112

As the error suggests, it only occurs when the transparent compiler is enabled.

I'd guess that was down to dotnet/fsharp#18205? Not sure what the fix is outside of handling the exceptions though, or how important it is if the transparent compiler is off by default, but raising ot for the record.

To Reproduce
I just saw the errors in the verbose logging when it tried to analyze my project with the latest Ionide and analyzers, with the transparent compiler enabled.

Environment (please complete the following information):

• OS: Windows 10
• Ionide version: 7.25.10
• VSCode version: 1.100.2
• dotnet SDK version: 9.0.300

[TheAngryByrd]

I think this should be fixable by adding a ProjectOptions to the various Contexts in the SDK and requiring those contexts to provide it.

[Numpsy]

You mean something like ionide/FSharp.Analyzers.SDK@570f658 ?

I might need to read up a bit on the FSharpProjectOptions / FSharpProjectSnapshot relationship - It looks like the analyzer only uses FSharpProjectOptions to get the 'OtherOptions' property, and OtherOptions is also available on FSharpProjectSnapshot, so does it make sense to make one or the other available rather than just the ProjectOptions?
(The discussion at dotnet/fsharp#18205 says it's left to callers to keep hold of the snapshot, and I don't know what information FSAutoComplete has to hand when it calls the analyzers)

[TheAngryByrd]

You mean something like ionide/FSharp.Analyzers.SDK@570f658 ?

Yep that looks like what I had in mind.

So does it make sense to make one or the other available rather than just the ProjectOptions?

The TransparentCompiler is marked as experimental, so it depends if we want to expose that more. I do think it would help Analyzer authors know what they have available rather than hoping whatever context you're in (FSAC or Cli) has the right info mapped into it.

In FSAC we did make a [DU with some members] (Signature) (implementation) that help keep the API consistent for properties we use frequently.

We should make a copy here in this repo.

[Numpsy]

We should make a copy here in this repo.

This repo, or the SDK one?

[TheAngryByrd]

Oh yeah, SDK 😂

[Numpsy]

Ok, something like

Numpsy/FSharp.Analyzers.SDK@659bbae
Numpsy@9ede28c

?

[TheAngryByrd]

Yep, looks good to me!