diff options
Diffstat (limited to 'src/libraries/Common/tests/TestUtilities/System/RetryHelper.cs')
| -rw-r--r-- | src/libraries/Common/tests/TestUtilities/System/RetryHelper.cs | 91 |
1 files changed, 91 insertions, 0 deletions
diff --git a/src/libraries/Common/tests/TestUtilities/System/RetryHelper.cs b/src/libraries/Common/tests/TestUtilities/System/RetryHelper.cs new file mode 100644 index 00000000000..92244c86c0e --- /dev/null +++ b/src/libraries/Common/tests/TestUtilities/System/RetryHelper.cs @@ -0,0 +1,91 @@ +// Licensed to the .NET Foundation under one or more agreements. +// The .NET Foundation licenses this file to you under the MIT license. +// See the LICENSE file in the project root for more information. + +using System.Collections.Generic; +using System.Threading; +using System.Threading.Tasks; + +namespace System +{ + public static partial class RetryHelper + { + private static readonly Func<int, int> s_defaultBackoffFunc = i => Math.Min(i * 100, 60_000); + + /// <summary>Executes the <paramref name="test"/> action up to a maximum of <paramref name="maxAttempts"/> times.</summary> + /// <param name="maxAttempts">The maximum number of times to invoke <paramref name="test"/>.</param> + /// <param name="test">The test to invoke.</param> + /// <param name="backoffFunc">After a failure, invoked to determine how many milliseconds to wait before the next attempt. It's passed the number of iterations attempted.</param> + public static void Execute(Action test, int maxAttempts = 5, Func<int, int> backoffFunc = null) + { + // Validate arguments + if (maxAttempts < 1) + { + throw new ArgumentOutOfRangeException(nameof(maxAttempts)); + } + if (test == null) + { + throw new ArgumentNullException(nameof(test)); + } + + // Execute the test until it either passes or we run it maxAttempts times + var exceptions = new List<Exception>(); + for (int i = 1; i <= maxAttempts; i++) + { + try + { + test(); + return; + } + catch (Exception e) + { + exceptions.Add(e); + if (i == maxAttempts) + { + throw new AggregateException(exceptions); + } + } + + Thread.Sleep((backoffFunc ?? s_defaultBackoffFunc)(i)); + } + } + + /// <summary>Executes the <paramref name="test"/> action up to a maximum of <paramref name="maxAttempts"/> times.</summary> + /// <param name="maxAttempts">The maximum number of times to invoke <paramref name="test"/>.</param> + /// <param name="test">The test to invoke.</param> + /// <param name="backoffFunc">After a failure, invoked to determine how many milliseconds to wait before the next attempt. It's passed the number of iterations attempted.</param> + public static async Task ExecuteAsync(Func<Task> test, int maxAttempts = 5, Func<int, int> backoffFunc = null) + { + // Validate arguments + if (maxAttempts < 1) + { + throw new ArgumentOutOfRangeException(nameof(maxAttempts)); + } + if (test == null) + { + throw new ArgumentNullException(nameof(test)); + } + + // Execute the test until it either passes or we run it maxAttempts times + var exceptions = new List<Exception>(); + for (int i = 1; i <= maxAttempts; i++) + { + try + { + await test().ConfigureAwait(false); + return; + } + catch (Exception e) + { + exceptions.Add(e); + if (i == maxAttempts) + { + throw new AggregateException(exceptions); + } + } + + await Task.Delay((backoffFunc ?? s_defaultBackoffFunc)(i)).ConfigureAwait(false); + } + } + } +}
\ No newline at end of file |