feat(csharp): refactor retry logic into RetryHelper for improved code organization

Author: Fluf22

clients/algoliasearch-client-csharp/algoliasearch/Utils/IngestionClientExtensions.cs

@@ -48,11 +48,6 @@ List<WatchResponse> ChunkedPush<T>(
 
 public partial class IngestionClient : IIngestionClient
 {
-  /// <summary>
-  /// The default maximum number of retries for search operations.
-  /// </summary>
-  public const int DefaultMaxRetries = 50;
-
   /// <summary>
   /// Helper: Chunks the given `objects` list in subset of 1000 elements max in order to make it fit
   /// in `push` requests by leveraging the Transformation pipeline setup in the Push connector
@@ -126,7 +121,7 @@ public async Task<List<WatchResponse>> ChunkedPushAsync<T>(
             );
           }
 
-          await RetryUntil(
+          await RetryHelper.RetryUntil(
               async () =>
               {
                 try
@@ -182,37 +177,4 @@ public List<WatchResponse> ChunkedPush<T>(
         cancellationToken
       )
     );
-
-  private static async Task<T> RetryUntil<T>(
-    Func<Task<T>> func,
-    Func<T, bool> validate,
-    int maxRetries = DefaultMaxRetries,
-    Func<int, int> timeout = null,
-    CancellationToken ct = default
-  )
-  {
-    timeout ??= NextDelay;
-
-    var retryCount = 0;
-    while (retryCount < maxRetries)
-    {
-      var resp = await func().ConfigureAwait(false);
-      if (validate(resp))
-      {
-        return resp;
-      }
-
-      await Task.Delay(timeout(retryCount), ct).ConfigureAwait(false);
-      retryCount++;
-    }
-
-    throw new AlgoliaException(
-      "The maximum number of retries exceeded. (" + (retryCount + 1) + "/" + maxRetries + ")"
-    );
-  }
-
-  private static int NextDelay(int retryCount)
-  {
-    return Math.Min(retryCount * 200, 5000);
-  }
 }

clients/algoliasearch-client-csharp/algoliasearch/Utils/RetryHelper.cs

@@ -0,0 +1,61 @@
+using System;
+using System.Threading;
+using System.Threading.Tasks;
+using Algolia.Search.Exceptions;
+
+namespace Algolia.Search.Utils;
+
+/// <summary>
+/// A helper class to retry operations
+/// </summary>
+public static class RetryHelper
+{
+  /// <summary>
+  /// The default maximum number of retries
+  /// </summary>
+  public const int DefaultMaxRetries = 50;
+
+  /// <summary>
+  /// Retry the given function until the validation function returns true or the maximum number of retries is reached
+  /// </summary>
+  /// <typeparam name="T">The type of the function's return value</typeparam>
+  /// <param name="func">The function to retry</param>
+  /// <param name="validate">The validation function</param>
+  /// <param name="maxRetries">The maximum number of retries</param>
+  /// <param name="timeout">A function that takes the retry count and returns the timeout in milliseconds before the next retry</param>
+  /// <param name="ct">A cancellation token to cancel the operation</param>
+  /// <returns>The result of the function if the validation function returns true</returns>
+  /// <exception cref="AlgoliaException">Thrown if the maximum number of retries is reached</exception>
+  public static async Task<T> RetryUntil<T>(
+      Func<Task<T>> func,
+      Func<T, bool> validate,
+      int maxRetries = DefaultMaxRetries,
+      Func<int, int> timeout = null,
+      CancellationToken ct = default
+    )
+    {
+      timeout ??= NextDelay;
+
+      var retryCount = 0;
+      while (retryCount < maxRetries)
+      {
+        var resp = await func().ConfigureAwait(false);
+        if (validate(resp))
+        {
+          return resp;
+        }
+
+        await Task.Delay(timeout(retryCount), ct).ConfigureAwait(false);
+        retryCount++;
+      }
+
+      throw new AlgoliaException(
+        "The maximum number of retries exceeded. (" + (retryCount + 1) + "/" + maxRetries + ")"
+      );
+    }
+
+    private static int NextDelay(int retryCount)
+    {
+      return Math.Min(retryCount * 200, 5000);
+    }
+}

clients/algoliasearch-client-csharp/algoliasearch/Utils/SearchClientExtensions.cs

@@ -531,7 +531,7 @@ public partial class SearchClient : ISearchClient
   /// <summary>
   /// The default maximum number of retries for search operations.
   /// </summary>
-  public const int DefaultMaxRetries = 50;
+  public const int DefaultMaxRetries = RetryHelper.DefaultMaxRetries;
 
   /// <inheritdoc/>
   public async Task<GetTaskResponse> WaitForTaskAsync(
@@ -541,17 +541,15 @@ public async Task<GetTaskResponse> WaitForTaskAsync(
     Func<int, int> timeout = null,
     RequestOptions requestOptions = null,
     CancellationToken ct = default
-  )
-  {
-    return await RetryUntil(
+  ) =>
+    await RetryHelper.RetryUntil(
         async () => await GetTaskAsync(indexName, taskId, requestOptions, ct),
         resp => resp.Status == Models.Search.TaskStatus.Published,
         maxRetries,
         timeout,
         ct
       )
       .ConfigureAwait(false);
-  }
 
   /// <inheritdoc/>
   public GetTaskResponse WaitForTask(
@@ -573,17 +571,15 @@ public async Task<GetTaskResponse> WaitForAppTaskAsync(
     Func<int, int> timeout = null,
     RequestOptions requestOptions = null,
     CancellationToken ct = default
-  )
-  {
-    return await RetryUntil(
+  ) =>
+    await RetryHelper.RetryUntil(
         async () => await GetAppTaskAsync(taskId, requestOptions, ct),
         resp => resp.Status == Models.Search.TaskStatus.Published,
         maxRetries,
         timeout,
         ct
       )
       .ConfigureAwait(false);
-  }
 
   /// <inheritdoc/>
   public GetTaskResponse WaitForAppTask(
@@ -613,7 +609,7 @@ public async Task<GetApiKeyResponse> WaitForApiKeyAsync(
         throw new AlgoliaException("`ApiKey` is required when waiting for an `update` operation.");
       }
 
-      return await RetryUntil(
+      return await RetryHelper.RetryUntil(
           () => GetApiKeyAsync(key, requestOptions, ct),
           resp =>
           {
@@ -637,7 +633,7 @@ public async Task<GetApiKeyResponse> WaitForApiKeyAsync(
         .ConfigureAwait(false);
     }
 
-    return await RetryUntil(
+    return await RetryHelper.RetryUntil(
       async () =>
       {
         try
@@ -879,39 +875,6 @@ public List<SearchForFacetValuesResponse> SearchForFacets(
       SearchForFacetsAsync(requests, searchStrategy, options, cancellationToken)
     );
 
-  private static async Task<T> RetryUntil<T>(
-    Func<Task<T>> func,
-    Func<T, bool> validate,
-    int maxRetries = DefaultMaxRetries,
-    Func<int, int> timeout = null,
-    CancellationToken ct = default
-  )
-  {
-    timeout ??= NextDelay;
-
-    var retryCount = 0;
-    while (retryCount < maxRetries)
-    {
-      var resp = await func().ConfigureAwait(false);
-      if (validate(resp))
-      {
-        return resp;
-      }
-
-      await Task.Delay(timeout(retryCount), ct).ConfigureAwait(false);
-      retryCount++;
-    }
-
-    throw new AlgoliaException(
-      "The maximum number of retries exceeded. (" + (retryCount + 1) + "/" + maxRetries + ")"
-    );
-  }
-
-  private static int NextDelay(int retryCount)
-  {
-    return Math.Min(retryCount * 200, 5000);
-  }
-
   /// <inheritdoc/>
   public async Task<ReplaceAllObjectsResponse> ReplaceAllObjectsAsync<T>(
     string indexName,