Refactor buildless telemetry logging

Author: tamasvajk

csharp/autobuilder/Semmle.Autobuild.CSharp/CSharpAutobuilder.cs

@@ -44,14 +44,16 @@ public class CSharpAutobuilder : Autobuilder<CSharpAutobuildOptions>
         public override BuildScript GetBuildScript()
         {
             var attempt = BuildScript.Failure;
-            switch (BuildStrategy)
+            switch (GetCSharpBuildStrategy())
             {
                 case CSharpBuildStrategy.CustomBuildCommand:
                     attempt = new BuildCommandRule(DotNetRule.WithDotNet).Analyse(this, false) & CheckExtractorRun(true);
                     break;
                 case CSharpBuildStrategy.Buildless:
                     // No need to check that the extractor has been executed in buildless mode
-                    attempt = new StandaloneBuildRule().Analyse(this, false);
+                    attempt = BuildScript.Bind(
+                        AddBuildlessStartedDiagnostic() & new StandaloneBuildRule().Analyse(this, false),
+                        AddBuildlessEndedDiagnostic);
                     break;
                 case CSharpBuildStrategy.MSBuild:
                     attempt = new MsBuildRule().Analyse(this, false) & CheckExtractorRun(true);
@@ -86,6 +88,52 @@ public BuildScript CheckExtractorRun(bool warnOnFailure) =>
                 return 1;
             });
 
+        private BuildScript AddBuildlessStartedDiagnostic()
+        {
+            return BuildScript.Create(actions =>
+            {
+                AddDiagnostic(new DiagnosticMessage(
+                    Options.Language,
+                    "buildless/mode-active",
+                    "C# with build-mode set to 'none'",
+                    visibility: new DiagnosticMessage.TspVisibility(statusPage: true, cliSummaryTable: true, telemetry: true),
+                    markdownMessage: "C# with build-mode set to 'none'. This means that all C# source in the working directory will be scanned, with build tools, such as Nuget and Dotnet CLIs, only contributing information about external dependencies.",
+                    severity: DiagnosticMessage.TspSeverity.Note
+                ));
+                return 0;
+            });
+        }
+
+        private BuildScript AddBuildlessEndedDiagnostic(int buildResult)
+        {
+            return BuildScript.Create(actions =>
+            {
+                if (buildResult == 0)
+                {
+                    AddDiagnostic(new DiagnosticMessage(
+                        Options.Language,
+                        "buildless/complete",
+                        "C# analysis with build-mode 'none' completed",
+                        visibility: new DiagnosticMessage.TspVisibility(statusPage: false, cliSummaryTable: true, telemetry: true),
+                        markdownMessage: "C# analysis with build-mode 'none' completed.",
+                        severity: DiagnosticMessage.TspSeverity.Unknown
+                    ));
+                }
+                else
+                {
+                    AddDiagnostic(new DiagnosticMessage(
+                        Options.Language,
+                        "buildless/failed",
+                        "C# analysis with build-mode 'none' failed",
+                        visibility: new DiagnosticMessage.TspVisibility(statusPage: true, cliSummaryTable: true, telemetry: true),
+                        markdownMessage: "C# analysis with build-mode 'none' failed.",
+                        severity: DiagnosticMessage.TspSeverity.Error
+                    ));
+                }
+                return buildResult;
+            });
+        }
+
         protected override void AutobuildFailureDiagnostic()
         {
             // if `ScriptPath` is not null here, the `BuildCommandAuto` rule was
@@ -218,10 +266,6 @@ private CSharpBuildStrategy GetCSharpBuildStrategy()
             return CSharpBuildStrategy.Auto;
         }
 
-        private CSharpBuildStrategy? buildStrategy = null;
-        private CSharpBuildStrategy BuildStrategy => buildStrategy ??= GetCSharpBuildStrategy();
-        public override bool IsBuildless => BuildStrategy == CSharpBuildStrategy.Buildless;
-
         private enum CSharpBuildStrategy
         {
             CustomBuildCommand,

csharp/autobuilder/Semmle.Autobuild.Shared/Autobuilder.cs

@@ -301,18 +301,6 @@ void exitCallback(int ret, string msg, bool silent)
             var onOutput = BuildOutputHandler(Console.Out);
             var onError = BuildOutputHandler(Console.Error);
 
-            if (IsBuildless)
-            {
-                AddDiagnostic(new DiagnosticMessage(
-                    Options.Language,
-                    "buildless/mode-active",
-                    "C# with build-mode set to 'none'",
-                    visibility: new DiagnosticMessage.TspVisibility(statusPage: true, cliSummaryTable: true, telemetry: true),
-                    markdownMessage: "C# with build-mode set to 'none'. This means that all C# source in the working directory will be scanned, with build tools, such as Nuget and Dotnet CLIs, only contributing information about external dependencies.",
-                    severity: DiagnosticMessage.TspSeverity.Note
-                ));
-            }
-
             var buildResult = script.Run(Actions, startCallback, exitCallback, onOutput, onError);
 
             // if the build succeeded, all diagnostics we captured from the build output should be warnings;
@@ -322,32 +310,6 @@ void exitCallback(int ret, string msg, bool silent)
                 .Select(result => result.ToDiagnosticMessage(this, diagSeverity))
                 .ForEach(AddDiagnostic);
 
-            if (IsBuildless)
-            {
-                if (buildResult == 0)
-                {
-                    AddDiagnostic(new DiagnosticMessage(
-                        Options.Language,
-                        "buildless/complete",
-                        "C# analysis with build-mode 'none' completed",
-                        visibility: new DiagnosticMessage.TspVisibility(statusPage: false, cliSummaryTable: true, telemetry: true),
-                        markdownMessage: "C# analysis with build-mode 'none' completed.",
-                        severity: DiagnosticMessage.TspSeverity.Unknown
-                    ));
-                }
-                else
-                {
-                    AddDiagnostic(new DiagnosticMessage(
-                        Options.Language,
-                        "buildless/failed",
-                        "C# analysis with build-mode 'none' failed",
-                        visibility: new DiagnosticMessage.TspVisibility(statusPage: true, cliSummaryTable: true, telemetry: true),
-                        markdownMessage: "C# analysis with build-mode 'none' failed.",
-                        severity: DiagnosticMessage.TspSeverity.Error
-                    ));
-                }
-            }
-
             return buildResult;
         }
 
@@ -356,8 +318,6 @@ void exitCallback(int ret, string msg, bool silent)
         /// </summary>
         public abstract BuildScript GetBuildScript();
 
-        public virtual bool IsBuildless { get; } = false;
-
 
         /// <summary>
         /// Produces a diagnostic for the tool status page that we were unable to automatically