dor-services-client 13.3.0 → 13.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0efe22194315ac58c5725e36126edd74d5ff09c465d1e8ccc3af0c94756e2ab3
-  data.tar.gz: dc60c7fb4f7410e878a257447f3fa9bdcb2aaadf639a769f5f12257855e0f900
+  metadata.gz: 9fc7a961142bc17fc963a387e6ee067b7c682eebebe455b26a7fde3f1d77ab13
+  data.tar.gz: 68c9d80398a759ae79b010d9391ed5b21f3478db4d9a80868f497ecdeabffa73
 SHA512:
-  metadata.gz: 9cf0562b1d1350a1aeeba117fed6ff4d1e03ca774afc937dc9e0ac1d9f7b833366529c38130af1584cc97837b616dd09cad967f872928e102328a0c8e811041e
-  data.tar.gz: 8de967354fb73c2a12b627be58f1caa785ce3e4b3349293d43cae8012606e3b914a40cd3d3126cbea7a395c8171b89f31263193ecb7f8999c036daa3e4ad32ba
+  metadata.gz: 9c4d4996966dd96f18c09ed4e5d59183e7400b2f794b113df3c722d451c61aec1e4dfecca6b4ae80eb23579b2208b9eabac3b38daa5c0f6b9f6c46cf40fb05df
+  data.tar.gz: 99ab68808e096af0d98046f79e461049bc1d7447a8c939deee07af50ceb68d20c247b8aadbd2b48c26aa4fdd27fddd10f3bb29e79c3fb23bedea0e2589ffa83f

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    dor-services-client (13.3.0)
+    dor-services-client (13.4.0)
       activesupport (>= 4.2, < 8)
       cocina-models (~> 0.93.0)
       deprecation
@@ -12,7 +12,7 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.1.1)
+    activesupport (7.1.2)
       base64
       bigdecimal
       concurrent-ruby (~> 1.0, >= 1.0.2)
@@ -26,7 +26,7 @@ GEM
       public_suffix (>= 2.0.2, < 6.0)
     ast (2.4.2)
     attr_extras (7.1.0)
-    base64 (0.1.1)
+    base64 (0.2.0)
     bigdecimal (3.1.4)
     byebug (11.1.3)
     cocina-models (0.93.0)
@@ -54,7 +54,7 @@ GEM
       activesupport
     diff-lcs (1.5.0)
     docile (1.4.0)
-    drb (2.1.1)
+    drb (2.2.0)
       ruby2_keywords
     dry-core (1.0.1)
       concurrent-ruby (~> 1.0)
@@ -79,7 +79,7 @@ GEM
       activesupport (>= 3.0, < 8.0)
     equivalent-xml (0.6.0)
       nokogiri (>= 1.4.3)
-    faraday (2.7.11)
+    faraday (2.7.12)
       base64
       faraday-net_http (>= 2.0, < 3.1)
       ruby2_keywords (>= 0.0.4)
@@ -96,10 +96,10 @@ GEM
     language_server-protocol (3.17.0.3)
     minitest (5.20.0)
     multi_json (1.15.0)
-    mutex_m (0.1.2)
-    nokogiri (1.15.4-x86_64-darwin)
+    mutex_m (0.2.0)
+    nokogiri (1.15.5-x86_64-darwin)
       racc (~> 1.4)
-    nokogiri (1.15.4-x86_64-linux)
+    nokogiri (1.15.5-x86_64-linux)
       racc (~> 1.4)
     openapi3_parser (0.9.2)
       commonmarker (~> 0.17)
@@ -111,7 +111,7 @@ GEM
       racc
     patience_diff (1.2.0)
       optimist (~> 3.0)
-    public_suffix (5.0.3)
+    public_suffix (5.0.4)
     racc (1.7.3)
     rainbow (3.1.1)
     rake (13.1.0)

data/lib/dor/services/client/version.rb

@@ -3,7 +3,7 @@
 module Dor
   module Services
     class Client
-      VERSION = '13.3.0'
+      VERSION = '13.4.0'
     end
   end
 end

data/lib/dor/services/client.rb

@@ -116,10 +116,12 @@ module Dor
         # @param [String] url the base url of the endpoint the client should connect to (required)
         # @param [String] token a bearer token for HTTP authentication (required)
         # @param [Boolean] enable_get_retries retries get requests on errors
-        def configure(url:, token:, enable_get_retries: false)
+        # @param [Logger,nil] logger for logging retry attempts
+        def configure(url:, token:, enable_get_retries: true, logger: nil)
           instance.url = url
           instance.token = token
           instance.enable_get_retries = enable_get_retries
+          instance.logger = logger
 
           # Force connection to be re-established when `.configure` is called
           instance.connection = nil
@@ -130,21 +132,21 @@ module Dor
         delegate :background_job_results, :objects, :object, :virtual_objects, :administrative_tags, to: :instance
       end
 
-      attr_writer :url, :token, :connection, :enable_get_retries
+      attr_writer :url, :token, :connection, :enable_get_retries, :logger
 
       private
 
-      attr_reader :token, :enable_get_retries
+      attr_reader :token, :enable_get_retries, :logger
 
       def url
         @url || raise(Error, 'url has not yet been configured')
       end
 
       def connection
-        @connection ||= ConnectionWrapper.new(connection: build_connection, get_connection: build_connection(with_retries: enable_get_retries))
+        @connection ||= build_connection(with_retries: enable_get_retries, logger: logger)
       end
 
-      def build_connection(with_retries: false)
+      def build_connection(with_retries: false, logger: nil)
         Faraday.new(url) do |builder|
           builder.use ErrorFaradayMiddleware
           builder.use Faraday::Request::UrlEncoded
@@ -157,10 +159,26 @@ module Dor
           builder.options[:timeout] = 300
           builder.headers[:user_agent] = user_agent
           builder.headers[TOKEN_HEADER] = "Bearer #{token}"
-          builder.request :retry, max: 4, interval: 1, backoff_factor: 2 if with_retries
+          builder.request :retry, retry_options(logger) if with_retries
         end
       end
 
+      def retry_options(logger) # rubocop:disable Metrics/MethodLength
+        {
+          max: 4,
+          interval: 1,
+          backoff_factor: 2,
+          exceptions: Faraday::Retry::Middleware::DEFAULT_EXCEPTIONS + [Faraday::ConnectionFailed],
+          methods: %i[get],
+          retry_statuses: [503],
+          # rubocop:disable Lint/UnusedBlockArgument
+          retry_block: lambda { |env:, options:, retry_count:, exception:, will_retry_in:|
+                         logger&.info("Retry #{retry_count + 1} for #{env.url} due to #{exception.class} (#{exception.message})")
+                       }
+          # rubocop:enable Lint/UnusedBlockArgument
+        }
+      end
+
       def user_agent
         "dor-services-client #{Dor::Services::Client::VERSION}"
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dor-services-client
 version: !ruby/object:Gem::Version
-  version: 13.3.0
+  version: 13.4.0
 platform: ruby
 authors:
 - Justin Coyne
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-11-09 00:00:00.000000000 Z
+date: 2023-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -242,7 +242,6 @@ files:
 - lib/dor/services/client/async_result.rb
 - lib/dor/services/client/background_job_results.rb
 - lib/dor/services/client/collections.rb
-- lib/dor/services/client/connection_wrapper.rb
 - lib/dor/services/client/error_faraday_middleware.rb
 - lib/dor/services/client/events.rb
 - lib/dor/services/client/members.rb
@@ -278,7 +277,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.19
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: A client for dor-services-app

data/lib/dor/services/client/connection_wrapper.rb

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-module Dor
-  module Services
-    class Client
-      # Wraps connections to allow GET requests to be retriable.
-      class ConnectionWrapper
-        delegate :get, to: :get_connection
-        delegate :post, :delete, :put, :patch, to: :connection
-
-        def initialize(connection:, get_connection:)
-          @connection = connection
-          @get_connection = get_connection
-        end
-
-        private
-
-        attr_reader :connection, :get_connection
-      end
-    end
-  end
-end