DotNetCliCommand: Add new RetryFailedBuildWithNoDeps property (#1982)

* DotNetCliCommand: Add new `RetryFailedBuildWithNoDeps` property

If a build fails, then it is retried with `--no-dependencies`. But this
can be problematic because msbuild can end up skipping some steps,
resulting in an incorrect build. And that can cause inexplicable issues
when running the benchmarks.

This is seen with wasm/aot builds with emcc, or wasm-ld crashes.

The property defaults to true, but is disabled for wasm builds.

Author: radical

src/BenchmarkDotNet/Toolchains/DotNetCli/DotNetCliBuilder.cs

@@ -14,13 +14,15 @@ public class DotNetCliBuilder : IBuilder
 
         private string CustomDotNetCliPath { get; }
         private bool LogOutput { get; }
+        private bool RetryFailedBuildWithNoDeps { get; }
 
         [PublicAPI]
-        public DotNetCliBuilder(string targetFrameworkMoniker, string customDotNetCliPath = null, bool logOutput = false)
+        public DotNetCliBuilder(string targetFrameworkMoniker, string customDotNetCliPath = null, bool logOutput = false, bool retryFailedBuildWithNoDeps = true)
         {
             TargetFrameworkMoniker = targetFrameworkMoniker;
             CustomDotNetCliPath = customDotNetCliPath;
             LogOutput = logOutput;
+            RetryFailedBuildWithNoDeps = retryFailedBuildWithNoDeps;
         }
 
         public BuildResult Build(GenerateResult generateResult, BuildPartition buildPartition, ILogger logger)
@@ -32,7 +34,8 @@ public BuildResult Build(GenerateResult generateResult, BuildPartition buildPart
                     buildPartition,
                     Array.Empty<EnvironmentVariable>(),
                     buildPartition.Timeout,
-                    logOutput: LogOutput)
+                    logOutput: LogOutput,
+                    retryFailedBuildWithNoDeps: RetryFailedBuildWithNoDeps)
                 .RestoreThenBuild();
     }
 }

src/BenchmarkDotNet/Toolchains/DotNetCli/DotNetCliCommand.cs

@@ -31,8 +31,11 @@ public class DotNetCliCommand
 
         [PublicAPI] public bool LogOutput { get; }
 
+        [PublicAPI] public bool RetryFailedBuildWithNoDeps { get; }
+
         public DotNetCliCommand(string cliPath, string arguments, GenerateResult generateResult, ILogger logger,
-            BuildPartition buildPartition, IReadOnlyList<EnvironmentVariable> environmentVariables, TimeSpan timeout, bool logOutput = false)
+            BuildPartition buildPartition, IReadOnlyList<EnvironmentVariable> environmentVariables, TimeSpan timeout, bool logOutput = false,
+            bool retryFailedBuildWithNoDeps = true)
         {
             CliPath = cliPath ?? DotNetCliCommandExecutor.DefaultDotNetCliPath.Value;
             Arguments = arguments;
@@ -42,6 +45,7 @@ public DotNetCliCommand(string cliPath, string arguments, GenerateResult generat
             EnvironmentVariables = environmentVariables;
             Timeout = timeout;
             LogOutput = logOutput || buildPartition.LogBuildOutput;
+            RetryFailedBuildWithNoDeps = retryFailedBuildWithNoDeps;
         }
 
         public DotNetCliCommand WithArguments(string arguments)
@@ -67,7 +71,7 @@ public BuildResult RestoreThenBuild()
                 return BuildResult.Failure(GenerateResult, restoreResult.AllInformation);
 
             var buildResult = BuildNoRestore();
-            if (!buildResult.IsSuccess) // if we fail to do the full build, we try with --no-dependencies
+            if (!buildResult.IsSuccess && RetryFailedBuildWithNoDeps) // if we fail to do the full build, we try with --no-dependencies
                 buildResult = BuildNoRestoreNoDependencies();
 
             return buildResult.ToBuildResult(GenerateResult);
@@ -93,7 +97,7 @@ public BuildResult RestoreThenBuildThenPublish()
                 return BuildResult.Failure(GenerateResult, restoreResult.AllInformation);
 
             var buildResult = BuildNoRestore();
-            if (!buildResult.IsSuccess) // if we fail to do the full build, we try with --no-dependencies
+            if (!buildResult.IsSuccess && RetryFailedBuildWithNoDeps) // if we fail to do the full build, we try with --no-dependencies
                 buildResult = BuildNoRestoreNoDependencies();
 
             if (!buildResult.IsSuccess)

src/BenchmarkDotNet/Toolchains/MonoWasm/WasmToolChain.cs

@@ -43,7 +43,8 @@ public static IToolchain From(NetCoreAppSettings netCoreAppSettings)
                     new DotNetCliBuilder(netCoreAppSettings.TargetFrameworkMoniker,
                         netCoreAppSettings.CustomDotNetCliPath,
                         // aot builds can be very slow
-                        logOutput: netCoreAppSettings.AOTCompilerMode == MonoAotLLVM.MonoAotCompilerMode.wasm),
+                        logOutput: netCoreAppSettings.AOTCompilerMode == MonoAotLLVM.MonoAotCompilerMode.wasm,
+                        retryFailedBuildWithNoDeps: false),
                     new Executor(),
                     netCoreAppSettings.CustomDotNetCliPath);
     }