File: src\ExecWithRetries.cs
Web Access
Project: src\src\Microsoft.DotNet.Build.Tasks.Installers\Microsoft.DotNet.Build.Tasks.Installers.csproj (Microsoft.DotNet.Build.Tasks.Installers)
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
 
// Initially copied from https://github.com/dotnet/buildtools/blob/6736870b84e06b75e7df32bb84d442db1b2afa10/src/Microsoft.DotNet.Build.Tasks/ExecWithRetries.cs
 
using Microsoft.Build.Framework;
using Microsoft.Build.Tasks;
using System;
using System.Threading;
using System.Threading.Tasks;
 
namespace Microsoft.DotNet.Build.Tasks.Installers
{
    /// <summary>
    /// Run a command and retry if the exit code is not 0.
    /// </summary>
    public class ExecWithRetries : BuildTask, ICancelableTask
    {
        [Required]
        public string Command { get; set; }
 
        public string WorkingDirectory { get; set; }
 
        public bool IgnoreStandardErrorWarningFormat { get; set; }
 
        public int MaxAttempts { get; set; } = 5;
 
        /// <summary>
        /// Base, in seconds, raised to the power of the number of retries so far.
        /// </summary>
        public double RetryDelayBase { get; set; } = 6;
 
        /// <summary>
        /// A constant, in seconds, added to (base^retries) to find the delay before retrying.
        /// 
        /// The default is -1 to make the first retry instant, because ((base^0)-1) == 0.
        /// </summary>
        public double RetryDelayConstant { get; set; } = -1;
 
        /// <summary>
        /// MSBuild message importance to use when logging stdout messages from the command. Default
        /// is "High".
        /// </summary>
        public string StandardOutputImportance { get; set; }
 
        /// <summary>
        /// MSBuild message importance to use when logging stderr messages from the command. Default
        /// is "High".
        /// </summary>
        public string StandardErrorImportance { get; set; }
 
        private CancellationTokenSource _cancelTokenSource = new CancellationTokenSource();
 
        private Exec _runningExec;
 
        public void Cancel()
        {
            _runningExec?.Cancel();
            _cancelTokenSource.Cancel();
        }
 
        public override bool Execute()
        {
            for (int i = 0; i < MaxAttempts; i++)
            {
                _runningExec = new Exec
                {
                    BuildEngine = BuildEngine,
                    Command = Command,
                    WorkingDirectory = WorkingDirectory,
                    IgnoreStandardErrorWarningFormat = IgnoreStandardErrorWarningFormat,
                    StandardOutputImportance = StandardOutputImportance,
                    StandardErrorImportance = StandardErrorImportance,
                    LogStandardErrorAsError = false,
                    IgnoreExitCode = true
                };
 
                if (!_runningExec.Execute())
                {
                    Log.LogError("Child Exec task failed to execute.");
                    break;
                }
 
                int exitCode = _runningExec.ExitCode;
                if (exitCode == 0)
                {
                    return true;
                }
 
                string message = $"Exec FAILED: exit code {exitCode} (attempt {i + 1}/{MaxAttempts})";
 
                if (i + 1 == MaxAttempts || _cancelTokenSource.IsCancellationRequested)
                {
                    Log.LogError(message);
                    break;
                }
 
                TimeSpan delay = TimeSpan.FromSeconds(
                    Math.Pow(RetryDelayBase, i) + RetryDelayConstant);
 
                Log.LogMessage(LogImportance.High, $"{message} -- Retrying after {delay}...");
 
                try
                {
                    Task.Delay(delay, _cancelTokenSource.Token).Wait();
                }
                catch (AggregateException e) when (e.InnerException is TaskCanceledException)
                {
                    break;
                }
            }
            return false;
        }
    }
}