feat(ruby): expose maximum number of retries (generated)

algolia/api-clients-automation#6461

Co-authored-by: algolia-bot <accounts+algolia-api-client-bot@algolia.com>
Co-authored-by: Eric Zaharia <94015633+eric-zaharia@users.noreply.github.com>
Co-authored-by: Thomas Raffray <Fluf22@users.noreply.github.com>

Author: 3 people

lib/algolia.rb

@@ -1,10 +1,9 @@
 # frozen_string_literal: true
 
-# Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
-
 # Common files
 require "algolia/api_client"
 require "algolia/api_error"
+require "algolia/chunked_helper_options"
 require "algolia/defaults"
 require "algolia/error"
 require "algolia/version"

lib/algolia/api/ingestion_client.rb

@@ -3606,14 +3606,15 @@ def chunked_push(
       wait_for_tasks = false,
       batch_size = 1000,
       reference_index_name = nil,
-      request_options = {}
+      request_options = {},
+      chunked_options = nil
     )
       responses = []
       offset = 0
       wait_batch_size = batch_size / 10
       wait_batch_size = batch_size if wait_batch_size < 1
       total_batches = (objects.length.to_f / batch_size).ceil
-      max_retries = 50
+      opts = Algolia::ChunkedHelperOptions.resolve(chunked_options)
 
       objects.each_slice(batch_size).with_index do |chunk, batch_index|
         response = push(
@@ -3641,7 +3642,13 @@ def chunked_push(
               end
 
               retries += 1
-              raise ApiError, "The maximum number of retries exceeded. (#{max_retries})" if retries >= max_retries
+              if retries >= opts.max_retries
+                raise(
+                  ApiError,
+                  "Stopped waiting for the task after #{opts.max_retries} retries. This does not mean the operation failed; it may still complete. If you need to keep polling, retry with a higher max_retries."
+                )
+              end
+
               sleep([retries * 1.5, 5].min)
             end
           end

lib/algolia/api/search_client.rb

@@ -3484,7 +3484,8 @@ def save_objects_with_transformation(
       objects,
       wait_for_tasks = false,
       batch_size = 1000,
-      request_options = {}
+      request_options = {},
+      chunked_options = nil
     )
       assert_ingestion_transporter!
 
@@ -3495,7 +3496,8 @@ def save_objects_with_transformation(
         wait_for_tasks,
         batch_size,
         nil,
-        request_options
+        request_options,
+        chunked_options
       )
     end
 
@@ -3517,7 +3519,8 @@ def partial_update_objects_with_transformation(
       create_if_not_exists = false,
       wait_for_tasks = false,
       batch_size = 1000,
-      request_options = {}
+      request_options = {},
+      chunked_options = nil
     )
       assert_ingestion_transporter!
 
@@ -3530,7 +3533,8 @@ def partial_update_objects_with_transformation(
         wait_for_tasks,
         batch_size,
         nil,
-        request_options
+        request_options,
+        chunked_options
       )
     end
 
@@ -3550,10 +3554,12 @@ def replace_all_objects_with_transformation(
       objects,
       batch_size = 1000,
       scopes = [Search::ScopeType::SETTINGS, Search::ScopeType::RULES, Search::ScopeType::SYNONYMS],
-      request_options = {}
+      request_options = {},
+      chunked_options = nil
     )
       assert_ingestion_transporter!
 
+      opts = Algolia::ChunkedHelperOptions.resolve(chunked_options)
       tmp_index_name = index_name + "_tmp_" + rand(10_000_000).to_s
 
       begin
@@ -3574,10 +3580,11 @@ def replace_all_objects_with_transformation(
           true,
           batch_size,
           index_name,
-          request_options
+          request_options,
+          opts
         )
 
-        wait_for_task(tmp_index_name, copy_operation_response.task_id)
+        wait_for_task(tmp_index_name, copy_operation_response.task_id, opts.max_retries)
 
         copy_operation_response = operation_index(
           index_name,
@@ -3589,7 +3596,7 @@ def replace_all_objects_with_transformation(
           request_options
         )
 
-        wait_for_task(tmp_index_name, copy_operation_response.task_id)
+        wait_for_task(tmp_index_name, copy_operation_response.task_id, opts.max_retries)
 
         move_operation_response = operation_index(
           tmp_index_name,
@@ -3600,7 +3607,7 @@ def replace_all_objects_with_transformation(
           request_options
         )
 
-        wait_for_task(tmp_index_name, move_operation_response.task_id)
+        wait_for_task(tmp_index_name, move_operation_response.task_id, opts.max_retries)
 
         search_watch_responses = watch_responses.map do |wr|
           Search::WatchResponse.build_from_hash(wr.to_hash)
@@ -3622,14 +3629,14 @@ def replace_all_objects_with_transformation(
     #
     # @param index_name [String] the `index_name` where the operation was performed. (required)
     # @param task_id [Integer] the `task_id` returned in the method response. (required)
-    # @param max_retries [Integer] the maximum number of retries. (optional, default to 50)
+    # @param max_retries [Integer] the maximum number of retries. (optional, default to Algolia::ChunkedHelperOptions::DEFAULT_MAX_RETRIES)
     # @param timeout [Proc] the function to decide how long to wait between retries. (optional)
     # @param request_options [Hash] the requestOptions to send along with the query, they will be forwarded to the `get_task` method.
     # @return [Http::Response] the last get_task response
     def wait_for_task(
       index_name,
       task_id,
-      max_retries = 50,
+      max_retries = Algolia::ChunkedHelperOptions::DEFAULT_MAX_RETRIES,
       timeout = -> (retry_count) { [retry_count * 200, 5000].min },
       request_options = {}
     )
@@ -3644,19 +3651,22 @@ def wait_for_task(
         sleep(timeout.call(retries) / 1000.0)
       end
 
-      raise ApiError, "The maximum number of retries exceeded. (#{max_retries})"
+      raise(
+        ApiError,
+        "Stopped waiting for the task after #{max_retries} retries. This does not mean the operation failed; it may still complete. If you need to keep polling, retry with a higher max_retries."
+      )
     end
 
     # Helper: Wait for an application-level task to be published (completed) for a given `task_id`.
     #
     # @param task_id [Integer] the `task_id` returned in the method response. (required)
-    # @param max_retries [Integer] the maximum number of retries. (optional, default to 50)
+    # @param max_retries [Integer] the maximum number of retries. (optional, default to Algolia::ChunkedHelperOptions::DEFAULT_MAX_RETRIES)
     # @param timeout [Proc] the function to decide how long to wait between retries. (optional)
     # @param request_options [Hash] the requestOptions to send along with the query, they will be forwarded to the `get_task` method.
     # @return [Http::Response] the last get_task response
     def wait_for_app_task(
       task_id,
-      max_retries = 50,
+      max_retries = Algolia::ChunkedHelperOptions::DEFAULT_MAX_RETRIES,
       timeout = -> (retry_count) { [retry_count * 200, 5000].min },
       request_options = {}
     )
@@ -3671,7 +3681,10 @@ def wait_for_app_task(
         sleep(timeout.call(retries) / 1000.0)
       end
 
-      raise ApiError, "The maximum number of retries exceeded. (#{max_retries})"
+      raise(
+        ApiError,
+        "Stopped waiting for the task after #{max_retries} retries. This does not mean the operation failed; it may still complete. If you need to keep polling, retry with a higher max_retries."
+      )
     end
 
     # Helper: Wait for an API key to be added, updated or deleted based on a given `operation`.
@@ -3687,7 +3700,7 @@ def wait_for_api_key(
       key,
       operation,
       api_key = Search::ApiKey.new,
-      max_retries = 50,
+      max_retries = Algolia::ChunkedHelperOptions::DEFAULT_MAX_RETRIES,
       timeout = -> (retry_count) { [retry_count * 200, 5000].min },
       request_options = {}
     )
@@ -3710,7 +3723,10 @@ def wait_for_api_key(
           sleep(timeout.call(retries) / 1000.0)
         end
 
-        raise ApiError, "The maximum number of retries exceeded. (#{max_retries})"
+        raise(
+          ApiError,
+          "Stopped waiting for the task after #{max_retries} retries. This does not mean the operation failed; it may still complete. If you need to keep polling, retry with a higher max_retries."
+        )
       end
 
       while retries < max_retries
@@ -3729,7 +3745,10 @@ def wait_for_api_key(
         sleep(timeout.call(retries) / 1000.0)
       end
 
-      raise ApiError, "The maximum number of retries exceeded. (#{max_retries})"
+      raise(
+        ApiError,
+        "Stopped waiting for the task after #{max_retries} retries. This does not mean the operation failed; it may still complete. If you need to keep polling, retry with a higher max_retries."
+      )
     end
 
     # Helper: Iterate on the `browse` method of the client to allow aggregating objects of an index.
@@ -3907,14 +3926,22 @@ def get_secured_api_key_remaining_validity(secured_api_key)
     #
     # @return [BatchResponse]
     #
-    def save_objects(index_name, objects, wait_for_tasks = false, batch_size = 1000, request_options = {})
+    def save_objects(
+      index_name,
+      objects,
+      wait_for_tasks = false,
+      batch_size = 1000,
+      request_options = {},
+      chunked_options = nil
+    )
       chunked_batch(
         index_name,
         objects,
         Search::Action::ADD_OBJECT,
         wait_for_tasks,
         batch_size,
-        request_options
+        request_options,
+        chunked_options
       )
     end
 
@@ -3928,14 +3955,22 @@ def save_objects(index_name, objects, wait_for_tasks = false, batch_size = 1000,
     #
     # @return [BatchResponse]
     #
-    def delete_objects(index_name, object_ids, wait_for_tasks = false, batch_size = 1000, request_options = {})
+    def delete_objects(
+      index_name,
+      object_ids,
+      wait_for_tasks = false,
+      batch_size = 1000,
+      request_options = {},
+      chunked_options = nil
+    )
       chunked_batch(
         index_name,
         object_ids.map { |id| {"objectID" => id} },
         Search::Action::DELETE_OBJECT,
         wait_for_tasks,
         batch_size,
-        request_options
+        request_options,
+        chunked_options
       )
     end
 
@@ -3956,15 +3991,17 @@ def partial_update_objects(
       create_if_not_exists,
       wait_for_tasks = false,
       batch_size = 1000,
-      request_options = {}
+      request_options = {},
+      chunked_options = nil
     )
       chunked_batch(
         index_name,
         objects,
         create_if_not_exists ? Search::Action::PARTIAL_UPDATE_OBJECT : Search::Action::PARTIAL_UPDATE_OBJECT_NO_CREATE,
         wait_for_tasks,
         batch_size,
-        request_options
+        request_options,
+        chunked_options
       )
     end
 
@@ -3985,8 +4022,10 @@ def chunked_batch(
       action = Action::ADD_OBJECT,
       wait_for_tasks = false,
       batch_size = 1000,
-      request_options = {}
+      request_options = {},
+      chunked_options = nil
     )
+      opts = Algolia::ChunkedHelperOptions.resolve(chunked_options)
       responses = []
       objects.each_slice(batch_size) do |chunk|
         requests = chunk.map do |object|
@@ -3998,7 +4037,7 @@ def chunked_batch(
 
       if wait_for_tasks
         responses.each do |response|
-          wait_for_task(index_name, response.task_id)
+          wait_for_task(index_name, response.task_id, opts.max_retries)
         end
       end
 
@@ -4019,8 +4058,10 @@ def replace_all_objects(
       objects,
       batch_size = 1000,
       scopes = [Search::ScopeType::SETTINGS, Search::ScopeType::RULES, Search::ScopeType::SYNONYMS],
-      request_options = {}
+      request_options = {},
+      chunked_options = nil
     )
+      opts = Algolia::ChunkedHelperOptions.resolve(chunked_options)
       tmp_index_name = index_name + "_tmp_" + rand(10_000_000).to_s
 
       begin
@@ -4040,10 +4081,11 @@ def replace_all_objects(
           Search::Action::ADD_OBJECT,
           true,
           batch_size,
-          request_options
+          request_options,
+          opts
         )
 
-        wait_for_task(tmp_index_name, copy_operation_response.task_id)
+        wait_for_task(tmp_index_name, copy_operation_response.task_id, opts.max_retries)
 
         copy_operation_response = operation_index(
           index_name,
@@ -4055,7 +4097,7 @@ def replace_all_objects(
           request_options
         )
 
-        wait_for_task(tmp_index_name, copy_operation_response.task_id)
+        wait_for_task(tmp_index_name, copy_operation_response.task_id, opts.max_retries)
 
         move_operation_response = operation_index(
           tmp_index_name,
@@ -4066,7 +4108,7 @@ def replace_all_objects(
           request_options
         )
 
-        wait_for_task(tmp_index_name, move_operation_response.task_id)
+        wait_for_task(tmp_index_name, move_operation_response.task_id, opts.max_retries)
 
         Search::ReplaceAllObjectsResponse.new(
           copy_operation_response: copy_operation_response,

lib/algolia/chunked_helper_options.rb

@@ -0,0 +1,15 @@
+module Algolia
+  # Optional configuration for chunked helpers that batch records and poll for task completion.
+  class ChunkedHelperOptions
+    DEFAULT_MAX_RETRIES = 100
+    attr_reader :max_retries
+
+    def initialize(max_retries: DEFAULT_MAX_RETRIES)
+      @max_retries = max_retries
+    end
+
+    def self.resolve(options)
+      options || new
+    end
+  end
+end