faraday_dynamic_timeout 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8e0d5c3fe787914d19d470b70182719f5c4863106a5d9fc4854df38e219f1a5a
-  data.tar.gz: 485e82cfdd0b9098801cffd08fad0426a763ec4a51c746b97a3a553c12281d2d
+  metadata.gz: a0f2d0bde754191015cbd03f7cf425170a36d65215a843e881dfb0b27b44482b
+  data.tar.gz: 88d59a4fc7dc1ea3addbf44c3043ae4fedea257a8ecf6bfe3acdceba60641fcf
 SHA512:
-  metadata.gz: a5025c609b11ae25188e685a15dc44ae55499fea41f16bad4c1cf925b3465942cf42ea77d734eeff8af417f6df7610c8c4dbe5032169dac22100004d1348bda0
-  data.tar.gz: 3443e7adc22b8bcc9c8b3adc2a25d24187b2f6b284e03429fcaabee8ff80299e976f8fe019cce1ffb3ff55a2020eb6b2be7b31cfe39c8773922327bb86fdc4de
+  metadata.gz: 4ab05d2fda3b8dc85a2d54b18abe9b7570e5452de94a5bfbabf373350a54be4046c7fa9c9693f925d518fb0d09a6766b24069e2bd7c726b0020e6fc0960ad7a1
+  data.tar.gz: b3e984c48e93af3aae37fac84a60efb18bd61eb8cf4f719b75e2b08187e7ec37bde20f3da87bb6950f3e11ce2175427bf0deaf326c88855b1cb4383771924f88

data/CHANGELOG.md

@@ -4,6 +4,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## 1.1.0
+
+### Added
+
+- Add `before_request` option on middleware to allow making custom changes to the request based on the timeout value being used.
+
 ## 1.0.0
 
 ### Added

data/README.md

@@ -50,6 +50,8 @@ In this example, the timeout will be set to 8 seconds if there are 5 or fewer re
 
 - `:name` - An optional name for the resource. By default the hostname and port of the request URL will be used to identify the resource. Each resource will report a separate count of concurrent requests and processes. You can group multiple resources from different hosts together with the `:name` option.
 
+- `:before_request` - An optional callback that will be called before each request is made. The callback can be a `Proc` or any object that responds to `call`. It will be called before the request is made with the `Faraday::Env` object and the timeout being used. You can use this to make changes to the request based on the timeout being used. This can be used, for example, to add the timeout to the request payload.
+
 - `:callback` - An optional callback that will be called after each request. The callback can be a `Proc` or any object that responds to `call`. It will be called with a `FaradayDyamicTimeout::RequestInfo` argument. You can use this to log the number of concurrent requests or to report metrics to a monitoring system. This can be very useful for tuning the bucket settings.
 
 ### Capacity Strategy
@@ -80,6 +82,14 @@ For this example, we will configure the `opensearch` gem with this middleware al
 # Set up a redis connection to coordinate counting concurrent requests.
 redis = Redis.new(url: ENV.fetch("REDIS_URL"))
 
+# Set the query timeout to match the request timeout so the search nodes will stop
+# processing if the request times out.
+set_query_timeout = ->(env, timeout) do
+  query_params = (Faraday::Utils.parse_query(env.url.query) || {})
+  query_params["timeout"] = "#{timeout}s"
+  env.url.query = Faraday::Utils.build_query(query_params)
+end
+
 # Set up a statsd client to report metrics with the DataDog extensions.
 statsd = Statsd.new(ENV.fetch("STATSD_HOST"), ENV.fetch("STATSD_PORT"))
 
@@ -102,6 +112,7 @@ client = OpenSearch::Client.new(host: 'localhost', port: '9200') do |faraday|
                   name: "opensearch",
                   redis: redis,
                   filter: ->(env) { env.url.path.end_with?("/_search") },
+                  before_request: set_payload_timeout,
                   callback: metrics_callback
 end
 ```

data/VERSION

@@ -1 +1 @@
-1.0.0
+1.1.0

data/lib/faraday_dynamic_timeout/middleware.rb

@@ -27,7 +27,7 @@ module FaradayDynamicTimeout
       count_request(env.url, redis, buckets, callback) do |request_count|
         execute_with_timeout(env.url, buckets, request_count, redis) do |timeout|
           bucket_timeout = timeout
-          set_timeout(env.request, timeout) if timeout
+          set_timeout(env, timeout) if timeout
 
           # Resetting the start time to more accurately reflect the time spent in the request.
           start_time = monotonic_time if callback
@@ -103,11 +103,14 @@ module FaradayDynamicTimeout
       retval
     end
 
-    def set_timeout(request, timeout)
+    def set_timeout(env, timeout)
+      request = env.request
       request.timeout = timeout
       request.open_timeout = nil
       request.write_timeout = nil
       request.read_timeout = nil
+
+      option(:before_request)&.call(env, timeout)
     end
 
     # Track how many requests are currently being executed only if a callback has been configured.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: faraday_dynamic_timeout
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Brian Durand
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-29 00:00:00.000000000 Z
+date: 2024-05-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -93,7 +93,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.12
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: Faraday middleware to dynamically set a request timeout based on the number