Refactor API client to reduce duplication

Author: yeikel

updater/lib/dependabot/api_client.rb

@@ -24,6 +24,10 @@ class ApiClient # rubocop:disable Metrics/ClassLength
 
     MAX_REQUEST_RETRIES = 3
     INVALID_REQUEST_MSG = /The request contains invalid or unauthorized changes/
+    NETWORK_ERRORS_TO_RESCUE_FROM = [
+      HTTP::ConnectionError,
+      OpenSSL::SSL::SSLError
+    ].freeze
 
     sig { params(base_url: String, job_id: T.any(String, Integer), job_token: String).void }
     def initialize(base_url, job_id, job_token)
@@ -49,7 +53,7 @@ def create_pull_request(dependency_change, base_commit_sha)
         elsif response.code >= 400
           raise ApiError, response.body
         end
-      rescue HTTP::ConnectionError, OpenSSL::SSL::SSLError
+      rescue *NETWORK_ERRORS_TO_RESCUE_FROM
         retry_count ||= 0
         retry_count += 1
         raise if retry_count > MAX_REQUEST_RETRIES
@@ -76,15 +80,7 @@ def update_pull_request(dependency_change, base_commit_sha)
             "base-commit-sha": base_commit_sha
           }
         }
-        response = http_client.post(api_url, json: body)
-        raise ApiError, response.body if response.code >= 400
-      rescue HTTP::ConnectionError, OpenSSL::SSL::SSLError
-        retry_count ||= 0
-        retry_count += 1
-        raise if retry_count > MAX_REQUEST_RETRIES
-
-        sleep(rand(3.0..10.0))
-        retry
+        send_http_request_with_retries(:post, api_url, body)
       end
     end
 
@@ -96,15 +92,7 @@ def close_pull_request(dependency_names, reason)
 
         api_url = "#{base_url}/update_jobs/#{job_id}/close_pull_request"
         body = { data: { "dependency-names": dependency_names, reason: reason } }
-        response = http_client.post(api_url, json: body)
-        raise ApiError, response.body if response.code >= 400
-      rescue HTTP::ConnectionError, OpenSSL::SSL::SSLError
-        retry_count ||= 0
-        retry_count += 1
-        raise if retry_count > MAX_REQUEST_RETRIES
-
-        sleep(rand(3.0..10.0))
-        retry
+        send_http_request_with_retries(:post, api_url, body)
       end
     end
 
@@ -123,15 +111,7 @@ def record_update_job_error(error_type:, error_details:)
             "error-details": error_details
           }
         }
-        response = http_client.post(api_url, json: body)
-        raise ApiError, response.body if response.code >= 400
-      rescue HTTP::ConnectionError, OpenSSL::SSL::SSLError
-        retry_count ||= 0
-        retry_count += 1
-        raise if retry_count > MAX_REQUEST_RETRIES
-
-        sleep(rand(3.0..10.0))
-        retry
+        send_http_request_with_retries(:post, api_url, body)
       end
     end
 
@@ -158,15 +138,7 @@ def record_update_job_warning(warn_type:, warn_title:, warn_description:)
             "warn-description": warn_description
           }
         }
-        response = http_client.post(api_url, json: body)
-        raise ApiError, response.body if response.code >= 400
-      rescue HTTP::ConnectionError, OpenSSL::SSL::SSLError
-        retry_count ||= 0
-        retry_count += 1
-        raise if retry_count > MAX_REQUEST_RETRIES
-
-        sleep(rand(3.0..10.0))
-        retry
+        send_http_request_with_retries(:post, api_url, body)
       end
     end
 
@@ -184,15 +156,7 @@ def record_update_job_unknown_error(error_type:, error_details:)
             "error-details": error_details
           }
         }
-        response = http_client.post(api_url, json: body)
-        raise ApiError, response.body if response.code >= 400
-      rescue HTTP::ConnectionError, OpenSSL::SSL::SSLError
-        retry_count ||= 0
-        retry_count += 1
-        raise if retry_count > MAX_REQUEST_RETRIES
-
-        sleep(rand(3.0..10.0))
-        retry
+        send_http_request_with_retries(:post, api_url, body)
       end
     end
 
@@ -204,15 +168,7 @@ def mark_job_as_processed(base_commit_sha)
 
         api_url = "#{base_url}/update_jobs/#{job_id}/mark_as_processed"
         body = { data: { "base-commit-sha": base_commit_sha } }
-        response = http_client.patch(api_url, json: body)
-        raise ApiError, response.body if response.code >= 400
-      rescue HTTP::ConnectionError, OpenSSL::SSL::SSLError
-        retry_count ||= 0
-        retry_count += 1
-        raise if retry_count > MAX_REQUEST_RETRIES
-
-        sleep(rand(3.0..10.0))
-        retry
+        send_http_request_with_retries(:patch, api_url, body)
       end
     end
 
@@ -228,15 +184,7 @@ def update_dependency_list(dependencies, dependency_files)
             dependency_files: dependency_files
           }
         }
-        response = http_client.post(api_url, json: body)
-        raise ApiError, response.body if response.code >= 400
-      rescue HTTP::ConnectionError, OpenSSL::SSL::SSLError
-        retry_count ||= 0
-        retry_count += 1
-        raise if retry_count > MAX_REQUEST_RETRIES
-
-        sleep(rand(3.0..10.0))
-        retry
+        send_http_request_with_retries(:post, api_url, body)
       end
     end
 
@@ -249,15 +197,7 @@ def create_dependency_submission(dependency_submission)
         body = {
           data: dependency_submission
         }
-        response = http_client.post(api_url, json: body)
-        raise ApiError, response.body if response.code >= 400
-      rescue HTTP::ConnectionError, OpenSSL::SSL::SSLError
-        retry_count ||= 0
-        retry_count += 1
-        raise if retry_count > MAX_REQUEST_RETRIES
-
-        sleep(rand(3.0..10.0))
-        retry
+        send_http_request_with_retries(:post, api_url, body)
       end
     end
 
@@ -268,15 +208,7 @@ def record_ecosystem_versions(ecosystem_versions)
         body = {
           data: { ecosystem_versions: ecosystem_versions }
         }
-        response = http_client.post(api_url, json: body)
-        raise ApiError, response.body if response.code >= 400
-      rescue HTTP::ConnectionError, OpenSSL::SSL::SSLError
-        retry_count ||= 0
-        retry_count += 1
-        raise if retry_count > MAX_REQUEST_RETRIES
-
-        sleep(rand(3.0..10.0))
-        retry
+        send_http_request_with_retries(:post, api_url, body)
       end
     end
 
@@ -299,7 +231,7 @@ def increment_metric(metric, tags:)
         response = http_client.post(api_url, json: body)
         # We treat metrics as fire-and-forget, so just warn if they fail.
         Dependabot.logger.debug("Unable to report metric '#{metric}'.") if response.code >= 400
-      rescue HTTP::ConnectionError, OpenSSL::SSL::SSLError
+      rescue *NETWORK_ERRORS_TO_RESCUE_FROM
         Dependabot.logger.debug("Unable to report metric '#{metric}'.")
       end
     end
@@ -401,6 +333,28 @@ def record_cooldown_meta(job)
 
     private
 
+    sig do
+      params(
+        request_type: T.any(Symbol, String),
+        api_url: String,
+        json: T::Hash[T.untyped, T.untyped]
+      ).void
+    end
+    def send_http_request_with_retries(request_type, api_url, json)
+      retry_count ||= 0
+
+      begin
+        response = http_client.public_send(request_type, api_url, json: json)
+        raise ApiError, response.body if response.code >= 400
+      rescue *NETWORK_ERRORS_TO_RESCUE_FROM => e
+        retry_count += 1
+        raise e if retry_count > MAX_REQUEST_RETRIES
+
+        sleep(rand(3.0..10.0))
+        retry
+      end
+    end
+
     # Update return type to allow returning a Hash or nil
     sig do
       params(version_manager: T.nilable(Dependabot::Ecosystem::VersionManager))