Optionally record activities in the service (#13835)

Co-authored-by: Chet Husk <chusk3@gmail.com>
Co-authored-by: Tomas Grosup <tomasgrosup@microsoft.com>

eng/Versions.props

@@ -88,6 +88,7 @@
     <SystemBuffersVersion>4.5.1</SystemBuffersVersion>
     <SystemCollectionsImmutableVersion>6.0.0</SystemCollectionsImmutableVersion>
     <MicrosoftDiaSymReaderPortablePdbVersion>1.6.0</MicrosoftDiaSymReaderPortablePdbVersion>
+    <SystemDiagnosticsDiagnosticSourceVersion>6.0.0</SystemDiagnosticsDiagnosticSourceVersion>
     <SystemMemoryVersion>4.5.5</SystemMemoryVersion>
     <SystemReflectionEmitVersion>4.7.0</SystemReflectionEmitVersion>
     <SystemReflectionMetadataVersion>6.0.0</SystemReflectionMetadataVersion>

src/Compiler/Checking/CheckDeclarations.fs

@@ -5,6 +5,7 @@ module internal FSharp.Compiler.CheckDeclarations
 open System
 open System.Collections.Generic
 
+open FSharp.Compiler.Diagnostics
 open Internal.Utilities.Collections
 open Internal.Utilities.Library
 open Internal.Utilities.Library.Extras
@@ -5289,11 +5290,17 @@ let CheckOneImplFile
         env,
         rootSigOpt: ModuleOrNamespaceType option,
         synImplFile) =
-
-    let (ParsedImplFileInput (_, isScript, qualNameOfFile, scopedPragmas, _, implFileFrags, isLastCompiland, _)) = synImplFile
+    
+    let (ParsedImplFileInput (fileName, isScript, qualNameOfFile, scopedPragmas, _, implFileFrags, isLastCompiland, _)) = synImplFile
     let infoReader = InfoReader(g, amap)
 
     cancellable {
+        use _ = 
+            Activity.start "CheckDeclarations.CheckOneImplFile" 
+                [|
+                    "fileName", fileName
+                    "qualifiedNameOfFile", qualNameOfFile.Text
+                |]
         let cenv = 
             cenv.Create (g, isScript, amap, thisCcu, false, Option.isSome rootSigOpt,
                 conditionalDefines, tcSink, (LightweightTcValForUsingInBuildMethodCall g), isInternalTestSpanStackReferring,
@@ -5421,6 +5428,12 @@ let CheckOneImplFile
 /// Check an entire signature file
 let CheckOneSigFile (g, amap, thisCcu, checkForErrors, conditionalDefines, tcSink, isInternalTestSpanStackReferring) tcEnv (sigFile: ParsedSigFileInput) = 
  cancellable {     
+    use _ =
+        Activity.start "CheckDeclarations.CheckOneSigFile"
+            [|
+                "fileName", sigFile.FileName
+                "qualifiedNameOfFile", sigFile.QualifiedName.Text
+            |]
     let cenv = 
         cenv.Create 
             (g, false, amap, thisCcu, true, false, conditionalDefines, tcSink,

src/Compiler/Driver/CompilerOptions.fs

@@ -2331,13 +2331,14 @@ let PrintWholeAssemblyImplementation (tcConfig: TcConfig) outfile header expr =
 //----------------------------------------------------------------------------
 
 let mutable tPrev: (DateTime * DateTime * float * int[]) option = None
-let mutable nPrev: string option = None
+let mutable nPrev: (string * IDisposable) option = None
 
 let ReportTime (tcConfig: TcConfig) descr =
-
     match nPrev with
     | None -> ()
-    | Some prevDescr ->
+    | Some (prevDescr, prevActivity) ->
+        use _ = prevActivity // Finish the previous diagnostics activity by .Dispose() at the end of this block
+
         if tcConfig.pause then
             dprintf "[done '%s', entering '%s'] press <enter> to continue... " prevDescr descr
             Console.ReadLine() |> ignore
@@ -2376,7 +2377,7 @@ let ReportTime (tcConfig: TcConfig) descr =
 
         let tStart =
             match tPrev, nPrev with
-            | Some (tStart, tPrev, utPrev, gcPrev), Some prevDescr ->
+            | Some (tStart, tPrev, utPrev, gcPrev), Some (prevDescr, _) ->
                 let spanGC = [| for i in 0..maxGen -> GC.CollectionCount i - gcPrev[i] |]
                 let t = tNow - tStart
                 let tDelta = tNow - tPrev
@@ -2403,7 +2404,7 @@ let ReportTime (tcConfig: TcConfig) descr =
 
         tPrev <- Some(tStart, tNow, utNow, gcNow)
 
-    nPrev <- Some descr
+    nPrev <- Some(descr, Activity.startNoTags descr)
 
 let ignoreFailureOnMono1_1_16 f =
     try

src/Compiler/Driver/ParseAndCheckInputs.fs

@@ -4,6 +4,7 @@
 module internal FSharp.Compiler.ParseAndCheckInputs
 
 open System
+open System.Diagnostics
 open System.IO
 open System.Collections.Generic
 
@@ -1175,6 +1176,9 @@ let CheckOneInputAux
 
     cancellable {
         try
+            use _ =
+                Activity.start "ParseAndCheckInputs.CheckOneInput" [| "fileName", inp.FileName |]
+
             CheckSimulateException tcConfig
 
             let m = inp.Range
@@ -1365,10 +1369,8 @@ let CheckMultipleInputsFinish (results, tcState: TcState) =
 
 let CheckOneInputAndFinish (checkForErrors, tcConfig: TcConfig, tcImports, tcGlobals, prefixPathOpt, tcSink, tcState, input) =
     cancellable {
-        Logger.LogBlockStart LogCompilerFunctionId.CompileOps_TypeCheckOneInputAndFinishEventually
         let! result, tcState = CheckOneInput(checkForErrors, tcConfig, tcImports, tcGlobals, prefixPathOpt, tcSink, tcState, input, false)
         let finishedResult = CheckMultipleInputsFinish([ result ], tcState)
-        Logger.LogBlockStop LogCompilerFunctionId.CompileOps_TypeCheckOneInputAndFinishEventually
         return finishedResult
     }
 

src/Compiler/Driver/fsc.fs

@@ -532,7 +532,6 @@ let main1
 
     // Process command line, flags and collect filenames
     let sourceFiles =
-
         // The ParseCompilerOptions function calls imperative function to process "real" args
         // Rather than start processing, just collect names, then process them.
         try
@@ -710,7 +709,6 @@ let main2
            exiter: Exiter,
            ilSourceDocs))
     =
-
     if tcConfig.typeCheckOnly then
         exiter.Exit 0
 
@@ -818,7 +816,6 @@ let main3
            exiter: Exiter,
            ilSourceDocs))
     =
-
     // Encode the signature data
     ReportTime tcConfig "Encode Interface Data"
     let exportRemapping = MakeExportRemapping generatedCcu generatedCcu.Contents
@@ -914,7 +911,6 @@ let main4
            exiter: Exiter,
            ilSourceDocs))
     =
-
     match tcImportsCapture with
     | None -> ()
     | Some f -> f tcImports
@@ -1049,7 +1045,6 @@ let main6
            exiter: Exiter,
            ilSourceDocs))
     =
-
     ReportTime tcConfig "Write .NET Binary"
 
     use _ = UseBuildPhase BuildPhase.Output

src/Compiler/FSharp.Compiler.Service.fsproj

@@ -29,7 +29,7 @@
 
   <!--  The FSharp.Compiler.Service dll provides a referencable public interface for tool builders -->
   <PropertyGroup Condition="'$(Configuration)' != 'Proto'">
-      <CompressMetadata Condition="'$(CompressAllMetadata)' != 'true'">false</CompressMetadata>
+    <CompressMetadata Condition="'$(CompressAllMetadata)' != 'true'">false</CompressMetadata>
   </PropertyGroup>
 
   <PropertyGroup>
@@ -57,6 +57,7 @@
     <NuspecProperty Include="SystemBuffersPackageVersion=$(SystemBuffersVersion)" />
     <NuspecProperty Include="SystemCollectionsImmutablePackageVersion=$(SystemCollectionsImmutableVersion)" />
     <NuspecProperty Include="SystemMemoryPackageVersion=$(SystemMemoryVersion)" />
+    <NuspecProperty Include="SystemDiagnosticsDiagnosticSourcePackageVersion=$(SystemDiagnosticsDiagnosticSourceVersion)" />
     <NuspecProperty Include="SystemReflectionEmitPackageVersion=$(SystemReflectionEmitVersion)" />
     <NuspecProperty Include="SystemReflectionMetadataPackageVersion=$(SystemReflectionMetadataVersion)" />
     <NuspecProperty Include="SystemRuntimeCompilerServicesUnsafePackageVersion=$(SystemRuntimeCompilerServicesUnsafeVersion)" />
@@ -91,6 +92,8 @@
       <Link>FSStrings.resx</Link>
       <LogicalName>FSStrings.resources</LogicalName>
     </EmbeddedResource>
+    <Compile Include="Utilities\Activity.fsi" />
+    <Compile Include="Utilities\Activity.fs" />
     <Compile Include="Utilities\sformat.fsi" />
     <Compile Include="Utilities\sformat.fs" />
     <Compile Include="Utilities\sr.fsi" />
@@ -131,8 +134,6 @@
     <Compile Include="Utilities\range.fsi" />
     <Compile Include="Utilities\range.fs" />
     <EmbeddedText Include="Facilities\UtilsStrings.txt" />
-    <Compile Include="Facilities\Logger.fsi" />
-    <Compile Include="Facilities\Logger.fs" />
     <Compile Include="Facilities\LanguageFeatures.fsi" />
     <Compile Include="Facilities\LanguageFeatures.fs" />
     <Compile Include="Facilities\DiagnosticOptions.fsi" />
@@ -488,6 +489,7 @@
     <PackageReference Include="System.Reflection.Emit" Version="$(SystemReflectionEmitVersion)" />
     <PackageReference Include="System.Reflection.Metadata" Version="$(SystemReflectionMetadataVersion)" />
     <PackageReference Include="System.Buffers" Version="$(SystemBuffersVersion)" />
+    <PackageReference Include="System.Diagnostics.DiagnosticSource" Version="$(SystemDiagnosticsDiagnosticSourceVersion)" />
     <PackageReference Include="System.Memory" Version="$(SystemMemoryVersion)" />
     <PackageReference Include="System.Runtime.CompilerServices.Unsafe" Version="$(SystemRuntimeCompilerServicesUnsafeVersion)" />
   </ItemGroup>

src/Compiler/FSharp.Compiler.Service.nuspec

@@ -8,6 +8,7 @@
             <dependency id="FSharp.Core" version="$FSharpCorePackageVersion$" exclude="Build,Analyzers" />
             <dependency id="System.Buffers" version="$SystemBuffersPackageVersion$" exclude="Build,Analyzers" />
             <dependency id="System.Collections.Immutable" version="$SystemCollectionsImmutablePackageVersion$" exclude="Build,Analyzers" />
+            <dependency id="System.Diagnostics.DiagnosticSource" version="$SystemDiagnosticsDiagnosticSourcePackageVersion$" exclude="Build,Analyzers" />
             <dependency id="System.Memory" version="$SystemMemoryPackageVersion$" exclude="Build,Analyzers" />
             <dependency id="System.Reflection.Emit" version="$SystemReflectionEmitPackageVersion$" exclude="Build,Analyzers" />
             <dependency id="System.Reflection.Metadata" version="$SystemReflectionMetadataPackageVersion$" exclude="Build,Analyzers" />

src/Compiler/Facilities/BuildGraph.fs

@@ -105,6 +105,16 @@ type NodeCodeBuilder() =
                     (value :> IDisposable).Dispose()
             }
         )
+
+    [<DebuggerHidden; DebuggerStepThrough>]
+    member _.Using(value: IDisposable, binder: IDisposable -> NodeCode<'U>) =
+        Node(
+            async {
+                use _ = value
+                return! binder value |> Async.AwaitNodeCode
+            }
+        )
+
 
 let node = NodeCodeBuilder()
 

src/Compiler/Facilities/BuildGraph.fsi

@@ -3,6 +3,7 @@
 module internal FSharp.Compiler.BuildGraph
 
 open System
+open System.Diagnostics
 open System.Threading
 open System.Threading.Tasks
 open FSharp.Compiler.DiagnosticsLogger
@@ -43,10 +44,12 @@ type NodeCodeBuilder =
 
     member Combine: x1: NodeCode<unit> * x2: NodeCode<'T> -> NodeCode<'T>
 
-    /// A limited form 'use' for establishing the compilation globals.  (Note
-    /// that a proper generic 'use' could be implemented but has not currently been necessary)
+    /// A limited form 'use' for establishing the compilation globals.
     member Using: CompilationGlobalsScope * (CompilationGlobalsScope -> NodeCode<'T>) -> NodeCode<'T>
 
+    /// A generic 'use' that disposes of the IDisposable at the end of the computation.
+    member Using: IDisposable * (IDisposable -> NodeCode<'T>) -> NodeCode<'T>
+
 /// Specifies code that can be run as part of the build graph.
 val node: NodeCodeBuilder
 

src/Compiler/Service/FSharpCheckerResults.fs

@@ -2347,6 +2347,7 @@ module internal ParseAndCheckFile =
 
     let parseFile (sourceText: ISourceText, fileName, options: FSharpParsingOptions, userOpName: string, suggestNamesForErrors: bool) =
         Trace.TraceInformation("FCS: {0}.{1} ({2})", userOpName, "parseFile", fileName)
+        use act = Activity.start "ParseAndCheckFile.parseFile" [| "fileName", fileName |]
 
         let errHandler =
             DiagnosticsHandler(true, fileName, options.DiagnosticOptions, sourceText, suggestNamesForErrors)
@@ -2502,7 +2503,8 @@ module internal ParseAndCheckFile =
         ) =
 
         cancellable {
-            use _logBlock = Logger.LogBlock LogCompilerFunctionId.Service_CheckOneFile
+            use _ =
+                Activity.start "ParseAndCheckFile.CheckOneFile" [| "fileName", mainInputFileName; "length", sourceText.Length.ToString() |]
 
             let parsedMainInput = parseResults.ParseTree