ethon 0.19.0 → 0.19.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 273826aa45dfd8fa89c7d86117d443a2460d7f766b0e1a0a717b2dcbb2af0b17
-  data.tar.gz: 2338c623556755ff816e49065fd15147084b0d6f3e14147de8cd6635c6229ba8
+  metadata.gz: 495f7cdb119483c6c3876354aa1ceeb8ae485ac25708280104213b2df28949e8
+  data.tar.gz: 6343bc21b68edfbce32389f739880c40a3506640249341c6bbd6eeca250e958f
 SHA512:
-  metadata.gz: 315d41d82ee366321ae2c0908b4d71d0d828c2533e2091923e5024ea364eee45858eb9e6b3c8bc00695e9443f4af2ed4e4b1c2acb8b962ff525988b24e2e75b9
-  data.tar.gz: f261db31635084b16314f58be9b2f525d89083a352db5ac96d88ed5e584f4e05c7d1cc116238186ccd656ca751989deee3d72900cec1f5e3c852ba57b65fe8ef
+  metadata.gz: e55248f897175f82a169ce09bb6a5b344f867027a3c3386935394adf058e0693501502ceb1cecb5748b1e1d7ca4c39eb0ce83321ee45ceb4ac73f5e0c032ba98
+  data.tar.gz: afbcbd73dc6a6e38f765d8ce89258711401b58cdda70e2b1fb7399d49b8bb0825fb400a47e489c4e23f86a222711859318550278056829fa7a87b2679e20505c

data/CHANGELOG.md

@@ -2,7 +2,31 @@
 
 ## Master
 
-[Full Changelog](https://github.com/typhoeus/ethon/compare/v0.19.0...master)
+[Full Changelog](https://github.com/typhoeus/ethon/compare/v0.19.1...master)
+
+## 0.19.1
+
+[Full Changelog](https://github.com/typhoeus/ethon/compare/v0.19.0...v0.19.1)
+
+### Behavior changes
+
+* Size a Multi's connection cache to twice the largest number of easy handles
+  attached at once. libcurl derives its default `CURLMOPT_MAXCONNECTS` from the
+  number of handles attached when a connection is returned, but Ethon detaches
+  finished handles immediately, which made the default shrink during a run and
+  close connections that later requests could have reused. An explicit
+  `maxconnects:` still takes precedence.
+  ([#455](https://github.com/typhoeus/ethon/pull/455))
+
+### Fixes and hardening
+
+* Allow `Easy#cleanup` from an `on_complete` callback. The transfer has
+  finished and a Multi detaches the handle before its callbacks run, so freeing
+  it is safe. Cleanup from body, header, and progress callbacks is still
+  rejected. This fixes `:resolve` requests in Typhoeus 1.7.0, which clean up
+  instead of pooling to avoid leaking `CURLOPT_RESOLVE` entries.
+  ([#456](https://github.com/typhoeus/ethon/pull/456),
+  [typhoeus#824](https://github.com/typhoeus/typhoeus/issues/824))
 
 ## 0.19.0
 

data/lib/ethon/easy/operations.rb

@@ -103,12 +103,17 @@ module Ethon
       # Cleanup is terminal: the native handle is freed and the Easy cannot be
       # used again. Reusing it raises Ethon::Errors::EthonError.
       #
+      # Cleanup is allowed from an on_complete callback: the transfer has
+      # finished and a Multi detaches the handle before running its callbacks.
+      # Cleanup from body, header, and progress callbacks is rejected because
+      # those run inside libcurl.
+      #
       # @example Perform clean up.
       #   easy.cleanup
       #
       # @return the result of the free which is nil
       def cleanup
-        ensure_not_performing!
+        ensure_not_in_transfer!
         ensure_not_attached_to_multi!
 
         # Resolve the handle first: cleanup must not clear the response body if

data/lib/ethon/multi/options.rb

@@ -32,6 +32,9 @@ module Ethon
 
       # Sets maxconnects option.
       #
+      # An explicit value also disables the automatic sizing described in
+      # #raise_default_maxconnects.
+      #
       # @example Set maxconnects option.
       #   multi.maxconnects = $value
       #
@@ -39,7 +42,8 @@ module Ethon
       #
       # @return [ void ]
       def maxconnects=(value)
-        Curl.set_option(:maxconnects, value_for(value, :int, :maxconnects), handle, :multi)
+        @maxconnects_configured = true unless value.nil?
+        set_maxconnects(value)
       end
 
       # Sets max_host_connections option.
@@ -156,6 +160,30 @@ module Ethon
 
       private
 
+      # Raise the default connection cache size to twice the largest number
+      # of easy handles ever attached at once.
+      #
+      # libcurl derives its default from the number of handles attached when
+      # a connection is returned. Ethon detaches each handle as soon as its
+      # transfer finishes, so that number falls during a run and libcurl
+      # closes connections that later requests could have reused.
+      #
+      # @param [ Integer ] count The number of attached handles after the
+      #   pending add.
+      #
+      # @return [ void ]
+      def raise_default_maxconnects(count)
+        return if @maxconnects_configured
+        return if count <= (@maxconnects_high_water ||= 0)
+
+        @maxconnects_high_water = count
+        set_maxconnects(2 * count)
+      end
+
+      def set_maxconnects(value)
+        Curl.set_option(:maxconnects, value_for(value, :int, :maxconnects), handle, :multi)
+      end
+
       def retain_callback(option, callback)
         if callback.nil?
           @procs.delete(option) if @procs

data/lib/ethon/multi/stack.rb

@@ -48,6 +48,12 @@ module Ethon
         multi_handle = handle
         easy_handle = easy.handle
 
+        # Pin libcurl's default connection cache size before the handle is
+        # attached. Finished handles are detached immediately, which would
+        # otherwise make the default shrink during a run and close reusable
+        # connections.
+        raise_default_maxconnects(stack.size + 1)
+
         stack << easy
         begin
           code = Curl.multi_add_handle(multi_handle, easy_handle)

data/lib/ethon/multi.rb

@@ -55,9 +55,13 @@ module Ethon
     #  as the Multi may invoke the callback. (Added in 7.16.0)
     # @option options :maxconnects [Integer]
     #  Pass a long. The set number will be used as the maximum amount of
-    #  simultaneously open connections that libcurl may cache. Default is
-    #  10, and libcurl will enlarge the size for each added easy handle to
-    #  make it fit 4 times the number of added easy handles.
+    #  simultaneously open connections that libcurl may cache. When this is
+    #  not set, Ethon sizes the cache to twice the largest number of easy
+    #  handles attached to this Multi at once. libcurl derives its own default
+    #  from the handles attached when a connection is returned, but Ethon
+    #  detaches finished handles, which would otherwise shrink the cache during
+    #  a run. Pass an explicit value to cap the cache yourself, or 0 to use
+    #  libcurl's dynamic default.
     #  By setting this option, you can prevent the cache size from growing
     #  beyond the limit set by you.
     #  When the cache is full, curl closes the oldest one in the cache to

data/lib/ethon/version.rb

@@ -2,5 +2,5 @@
 module Ethon
 
   # Ethon version.
-  VERSION = '0.19.0'
+  VERSION = '0.19.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ethon
 version: !ruby/object:Gem::Version
-  version: 0.19.0
+  version: 0.19.1
 platform: ruby
 authors:
 - Hans Hasselberg
@@ -134,10 +134,10 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/typhoeus/ethon/issues
-  changelog_uri: https://github.com/typhoeus/ethon/blob/v0.19.0/CHANGELOG.md
-  documentation_uri: https://www.rubydoc.info/gems/ethon/0.19.0
+  changelog_uri: https://github.com/typhoeus/ethon/blob/v0.19.1/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/gems/ethon/0.19.1
   rubygems_mfa_required: 'true'
-  source_code_uri: https://github.com/typhoeus/ethon/tree/v0.19.0
+  source_code_uri: https://github.com/typhoeus/ethon/tree/v0.19.1
 post_install_message:
 rdoc_options: []
 require_paths: