webmock 3.20.0 → 3.23.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ffda5916fee8f80d1d0a725b7de314652a588658189bb28ad7a984551d406a3a
-  data.tar.gz: f2aa5c1f78094f72f9c7310dfbb3e866be2acc6910bd3c3a1a4e562744e0fa65
+  metadata.gz: 8a2d1add2b84d303329a722f0c7e9643f237949d0dc471ea1678021324cd41b4
+  data.tar.gz: e00640f1b7664959922011ae2f7b922811d94be4fb1bea90a988f3cca83486bc
 SHA512:
-  metadata.gz: e3fbfb98e4a6d090abd630ccfea78f5b06038e3f6d4683bd1f651f6c8b07b31698f71f9588df1a8d90066ab0d38a088a604204b4f710bfd9249235a9f2664453
-  data.tar.gz: ffcaf10bc3cd523f6c12c2209fc4e48fb34813e520789ca78ee0cb65b3285f7bf1534ef36faafbd61a49d82ca547f2ecfb3ea74b33b5ba3b4294493f0683942d
+  metadata.gz: 87f797196dedde96873a3740234d33f799745df144953ccfc36403ca6fbe4bd239f5f05818eb7cec25730823c2f99f83a1f42b79cf977b5672d720ed02bb3495
+  data.tar.gz: af708a4202382fb1a55c90a7f2c14b1a9d9b277bc8c4ee898dd31b712162bee4e9fb1fb6dd2931c1e39123eee8f15545db9fcd198ea5751f746be7eabfad33eb

data/CHANGELOG.md

@@ -1,5 +1,37 @@
 # Changelog
 
+# 3.23.0
+
+ * Fixed HTTP.rb adapter to support streaming real responses when WebMock is enabled.
+
+    Thanks to [Viacheslav Nepomniashchikh](https://github.com/aka-nez) for reporting and investigating this [issue](https://github.com/bblimke/webmock/issues/1017).
+
+# 3.22.0
+
+  * Addressed an issue in the HTTPClient adapter where memoized stubbed responses and memoized request_signatures were incorrectly persisted between subsequent requests ([#1019](https://github.com/bblimke/webmock/issues/1019)). The implementation of a more robust thread-safety solution by [Tom Beauvais](https://github.com/tbeauvais) in [PR #300](https://github.com/bblimke/webmock/pull/300) not only resolved the memoization problem but also enhanced the overall thread safety of the adapter. This update ensures that stubbed responses and request signatures are correctly isolated to individual requests, improving both consistency and thread safety.
+
+# 3.21.2
+
+  * Corrected type checking in `WebMock::Response#assert_valid_body!` to accurately recognize `Hash` objects. Additionally, improved the clarity of the error message for unsupported body types, guiding users towards proper usage.
+
+    Thanks to [Jake Robb](https://github.com/jakerobb) for reporting.
+
+# 3.21.1
+
+  * The stubbed Net::HTTPResponse#uri now returns request.uri, aligning it with the behavior of an actual Net::HTTPResponse.
+
+    Thanks to [Abe Voelker](https://github.com/abevoelker) for reporting and to [Victor Maslov](https://github.com/Nakilon) and [Gio Lodi](https://github.com/mokagio) for the suggested solution.
+
+# 3.21.0
+
+  * Don't use deprecated Rack::VERSION for Rack >= 3
+
+    Thanks to [Étienne Barrié](https://github.com/etiennebarrie)
+
+  * Updated HTTPClient adapter, to build request signature using the URI after filters have been applied.
+
+    Thanks to [Matt Brown](https://github.com/mattbnz)
+
 # 3.20.0
 
   * Optimised EmHttpRequestAdapter performance.
@@ -178,7 +210,7 @@
 
   * Fixed async-http adapter to only considered requests as real if they are real.
 
-    Thanks to Thanks to [Tony Schneider](https://github.com/tonywok) and [Samuel Williams](https://github.com/ioquatix)
+    Thanks to [Tony Schneider](https://github.com/tonywok) and [Samuel Williams](https://github.com/ioquatix)
 
 # 3.11.2
 

data/README.md

@@ -1,7 +1,7 @@
 WebMock
 =======
 [![Gem Version](https://badge.fury.io/rb/webmock.svg)](http://badge.fury.io/rb/webmock)
-[![Build Status](https://github.com/bblimke/webmock/workflows/CI/badge.svg?branch=master)](https://github.com/bblimke/webmock/actions)
+[![Build Status](https://github.com/bblimke/webmock/actions/workflows/CI.yml/badge.svg?branch=master)](https://github.com/bblimke/webmock/actions)
 [![Code Climate](https://codeclimate.com/github/bblimke/webmock/badges/gpa.svg)](https://codeclimate.com/github/bblimke/webmock)
 [![Mentioned in Awesome Ruby](https://awesome.re/mentioned-badge.svg)](https://github.com/markets/awesome-ruby)
 
@@ -606,7 +606,11 @@ which can be passed to `WebMock.allow_net_connect!` and `WebMock.disable_net_con
 WebMock.allow_net_connect!(net_http_connect_on_start: true)
 ```
 
-This forces WebMock Net::HTTP adapter to always connect on `Net::HTTP.start`.
+This forces WebMock Net::HTTP adapter to always connect on `Net::HTTP.start`. At the time of connection being made there is no information about the request or URL yet, therefore WebMock is not able to decide whether to stub a request or not and all connections are allowed. To enable connections only to a specific domain (e.g. your test server) use:
+
+```ruby
+WebMock.allow_net_connect!(net_http_connect_on_start: "www.example.com")
+```
 
 ## Setting Expectations
 
@@ -1193,6 +1197,11 @@ People who submitted patches and new features or suggested improvements. Many th
 * Earlopain
 * James Brown
 * Kazuhiro NISHIYAMA
+* Étienne Barrié
+* Matt Brown
+* Victor Maslov
+* Gio Lodi
+* Ryan Brooks
 
 For a full list of contributors you can visit the
 [contributors](https://github.com/bblimke/webmock/contributors) page.

data/lib/webmock/http_lib_adapters/http_rb/response.rb

@@ -6,9 +6,19 @@ module HTTP
       webmock_response = ::WebMock::Response.new
 
       webmock_response.status  = [status.to_i, reason]
+
       webmock_response.body    = body.to_s
-      webmock_response.headers = headers.to_h
+      # This call is used to reset the body of the response to enable it to be streamed if necessary.
+      # The `body.to_s` call above reads the body, which allows WebMock to trigger any registered callbacks.
+      # However, once the body is read to_s, it cannot be streamed again and attempting to do so
+      # will raise a "HTTP::StateError: body has already been consumed" error.
+      # To avoid this error, we replace the original body with a new one.
+      # The new body has its @stream attribute set to new Streamer, instead of the original Connection.
+      # Unfortunately, it's not possible to reset the original body to its initial streaming state.
+      # Therefore, this replacement is the best workaround currently available.
+      reset_body_to_allow_it_to_be_streamed!(webmock_response)
 
+      webmock_response.headers = headers.to_h
       webmock_response
     end
 
@@ -21,16 +31,7 @@ module HTTP
         # HTTP.rb 3.0+ uses a keyword argument to pass the encoding, but 1.x
         # and 2.x use a positional argument, and 0.x don't support supplying
         # the encoding.
-        body = if HTTP::VERSION < "1.0.0"
-          Body.new(Streamer.new(webmock_response.body))
-        elsif HTTP::VERSION < "3.0.0"
-          Body.new(Streamer.new(webmock_response.body), webmock_response.body.encoding)
-        else
-          Body.new(
-            Streamer.new(webmock_response.body, encoding: webmock_response.body.encoding),
-            encoding: webmock_response.body.encoding
-          )
-        end
+        body = build_http_rb_response_body_from_webmock_response(webmock_response)
 
         return new(status, "1.1", headers, body, uri) if HTTP::VERSION < "1.0.0"
 
@@ -54,7 +55,18 @@ module HTTP
         })
       end
 
-      private
+      def build_http_rb_response_body_from_webmock_response(webmock_response)
+        if HTTP::VERSION < "1.0.0"
+          Body.new(Streamer.new(webmock_response.body))
+        elsif HTTP::VERSION < "3.0.0"
+          Body.new(Streamer.new(webmock_response.body), webmock_response.body.encoding)
+        else
+          Body.new(
+            Streamer.new(webmock_response.body, encoding: webmock_response.body.encoding),
+            encoding: webmock_response.body.encoding
+          )
+        end
+      end
 
       def normalize_uri(uri)
         return unless uri
@@ -65,5 +77,11 @@ module HTTP
         uri
       end
     end
+
+    private
+
+    def reset_body_to_allow_it_to_be_streamed!(webmock_response)
+      @body = self.class.build_http_rb_response_body_from_webmock_response(webmock_response)
+    end
   end
 end

data/lib/webmock/http_lib_adapters/http_rb_adapter.rb

@@ -31,9 +31,9 @@ if defined?(HTTP) && defined?(HTTP::VERSION)
     end
   end
 
-  require "webmock/http_lib_adapters/http_rb/client"
-  require "webmock/http_lib_adapters/http_rb/request"
-  require "webmock/http_lib_adapters/http_rb/response"
-  require "webmock/http_lib_adapters/http_rb/streamer"
-  require "webmock/http_lib_adapters/http_rb/webmock"
+  require_relative "http_rb/client"
+  require_relative "http_rb/request"
+  require_relative "http_rb/response"
+  require_relative "http_rb/streamer"
+  require_relative "http_rb/webmock"
 end

data/lib/webmock/http_lib_adapters/httpclient_adapter.rb

@@ -45,6 +45,8 @@ if defined?(::HTTPClient)
   end
 
   module WebMockHTTPClients
+    WEBMOCK_HTTPCLIENT_RESPONSES = :webmock_httpclient_responses
+    WEBMOCK_HTTPCLIENT_REQUEST_SIGNATURES = :webmock_httpclient_request_signatures
 
     REQUEST_RESPONSE_LOCK = Mutex.new
 
@@ -57,12 +59,14 @@ if defined?(::HTTPClient)
     end
 
     def do_get(req, proxy, conn, stream = false, &block)
+      clear_thread_variables unless conn.async_thread
+
       request_signature = build_request_signature(req, :reuse_existing)
 
       WebMock::RequestRegistry.instance.requested_signatures.put(request_signature)
 
       if webmock_responses[request_signature]
-        webmock_response = synchronize_request_response { webmock_responses.delete(request_signature) }
+        webmock_response = webmock_responses.delete(request_signature)
         response = build_httpclient_response(webmock_response, stream, req.header, &block)
         @request_filter.each do |filter|
           filter.filter_response(req, response)
@@ -73,7 +77,7 @@ if defined?(::HTTPClient)
         res
       elsif WebMock.net_connect_allowed?(request_signature.uri)
         # in case there is a nil entry in the hash...
-        synchronize_request_response { webmock_responses.delete(request_signature) }
+        webmock_responses.delete(request_signature)
 
         res = if stream
           do_get_stream_without_webmock(req, proxy, conn, &block)
@@ -103,12 +107,16 @@ if defined?(::HTTPClient)
     end
 
     def do_request_async(method, uri, query, body, extheader)
+      clear_thread_variables
       req = create_request(method, uri, query, body, extheader)
       request_signature = build_request_signature(req)
-      synchronize_request_response { webmock_request_signatures << request_signature }
+      webmock_request_signatures << request_signature
 
       if webmock_responses[request_signature] || WebMock.net_connect_allowed?(request_signature.uri)
-        super
+        conn = super
+        conn.async_thread[WEBMOCK_HTTPCLIENT_REQUEST_SIGNATURES] = Thread.current[WEBMOCK_HTTPCLIENT_REQUEST_SIGNATURES]
+        conn.async_thread[WEBMOCK_HTTPCLIENT_RESPONSES] = Thread.current[WEBMOCK_HTTPCLIENT_RESPONSES]
+        conn
       else
         raise WebMock::NetConnectNotAllowedError.new(request_signature)
       end
@@ -157,14 +165,14 @@ if defined?(::HTTPClient)
     end
 
     def build_request_signature(req, reuse_existing = false)
-      uri = WebMock::Util::URI.heuristic_parse(req.header.request_uri.to_s)
-      uri.query = WebMock::Util::QueryMapper.values_to_query(req.header.request_query, notation: WebMock::Config.instance.query_values_notation) if req.header.request_query
-      uri.port = req.header.request_uri.port
-
       @request_filter.each do |filter|
         filter.filter_request(req)
       end
 
+      uri = WebMock::Util::URI.heuristic_parse(req.header.request_uri.to_s)
+      uri.query = WebMock::Util::QueryMapper.values_to_query(req.header.request_query, notation: WebMock::Config.instance.query_values_notation) if req.header.request_query
+      uri.port = req.header.request_uri.port
+
       headers = req.header.all.inject({}) do |hdrs, header|
         hdrs[header[0]] ||= []
         hdrs[header[0]] << header[1]
@@ -188,22 +196,18 @@ if defined?(::HTTPClient)
     end
 
     def webmock_responses
-      @webmock_responses ||= Hash.new do |hash, request_signature|
-        synchronize_request_response do
-          hash[request_signature] = WebMock::StubRegistry.instance.response_for_request(request_signature)
-        end
+      Thread.current[WEBMOCK_HTTPCLIENT_RESPONSES] ||= Hash.new do |hash, request_signature|
+        hash[request_signature] = WebMock::StubRegistry.instance.response_for_request(request_signature)
       end
     end
 
     def webmock_request_signatures
-      @webmock_request_signatures ||= []
+      Thread.current[WEBMOCK_HTTPCLIENT_REQUEST_SIGNATURES] ||= []
     end
 
     def previous_signature_for(signature)
-      synchronize_request_response do
-        return nil unless index = webmock_request_signatures.index(signature)
-        webmock_request_signatures.delete_at(index)
-      end
+      return nil unless index = webmock_request_signatures.index(signature)
+      webmock_request_signatures.delete_at(index)
     end
 
     private
@@ -219,14 +223,9 @@ if defined?(::HTTPClient)
       end
     end
 
-    def synchronize_request_response
-      if REQUEST_RESPONSE_LOCK.owned?
-        yield
-      else
-        REQUEST_RESPONSE_LOCK.synchronize do
-          yield
-        end
-      end
+    def clear_thread_variables
+      Thread.current[WEBMOCK_HTTPCLIENT_REQUEST_SIGNATURES] = nil
+      Thread.current[WEBMOCK_HTTPCLIENT_RESPONSES] = nil
     end
   end
 

data/lib/webmock/http_lib_adapters/net_http.rb

@@ -77,7 +77,7 @@ module WebMock
             @socket = Net::HTTP.socket_type.new
             WebMock::CallbackRegistry.invoke_callbacks(
               {lib: :net_http}, request_signature, webmock_response)
-            build_net_http_response(webmock_response, &block)
+            build_net_http_response(webmock_response, request.uri, &block)
           elsif WebMock.net_connect_allowed?(request_signature.uri)
             check_right_http_connection
             after_request = lambda do |response|
@@ -144,7 +144,7 @@ module WebMock
           end
         end
 
-        def build_net_http_response(webmock_response, &block)
+        def build_net_http_response(webmock_response, request_uri, &block)
           response = Net::HTTPResponse.send(:response_class, webmock_response.status[0].to_s).new("1.0", webmock_response.status[0].to_s, webmock_response.status[1])
           body = webmock_response.body
           body = nil if webmock_response.status[0].to_s == '204'
@@ -159,6 +159,8 @@ module WebMock
 
           response.instance_variable_set(:@read, true)
 
+          response.uri = request_uri
+
           response.extend Net::WebMockHTTPResponse
 
           if webmock_response.should_timeout

data/lib/webmock/rack_response.rb

@@ -47,7 +47,9 @@ module WebMock
       # Rack-specific variables
       env['rack.input']      = StringIO.new(body)
       env['rack.errors']     = $stderr
-      env['rack.version']    = Rack::VERSION
+      if !Rack.const_defined?(:RELEASE) || Rack::RELEASE < "3"
+        env['rack.version']    = Rack::VERSION
+      end
       env['rack.url_scheme'] = uri.scheme
       env['rack.run_once']   = true
       env['rack.session']    = session

data/lib/webmock/response.rb

@@ -117,11 +117,11 @@ module WebMock
       return if @body.nil?
       return if valid_types.any? { |c| @body.is_a?(c) }
 
-      if @body.class.is_a?(Hash)
-        raise InvalidBody, "must be one of: #{valid_types}, but you've used a #{@body.class}' instead." \
-          "\n What shall we encode it to? try calling .to_json .to_xml instead on the hash instead, or otherwise convert it to a string."
+      if @body.is_a?(Hash)
+        raise InvalidBody, "must be one of: #{valid_types}, but you've used a #{@body.class}. " \
+          "Please convert it by calling .to_json .to_xml, or otherwise convert it to a string."
       else
-        raise InvalidBody, "must be one of: #{valid_types}. '#{@body.class}' given"
+        raise InvalidBody, "must be one of: #{valid_types}. '#{@body.class}' given."
       end
     end
 

data/lib/webmock/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module WebMock
-  VERSION = '3.20.0' unless defined?(::WebMock::VERSION)
+  VERSION = '3.23.0' unless defined?(::WebMock::VERSION)
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: webmock
 version: !ruby/object:Gem::Version
-  version: 3.20.0
+  version: 3.23.0
 platform: ruby
 authors:
 - Bartosz Blimke
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-02-06 00:00:00.000000000 Z
+date: 2024-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -371,9 +371,9 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/bblimke/webmock/issues
-  changelog_uri: https://github.com/bblimke/webmock/blob/v3.20.0/CHANGELOG.md
-  documentation_uri: https://www.rubydoc.info/gems/webmock/3.20.0
-  source_code_uri: https://github.com/bblimke/webmock/tree/v3.20.0
+  changelog_uri: https://github.com/bblimke/webmock/blob/v3.23.0/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/gems/webmock/3.23.0
+  source_code_uri: https://github.com/bblimke/webmock/tree/v3.23.0
   wiki_uri: https://github.com/bblimke/webmock/wiki
 post_install_message:
 rdoc_options: []
@@ -390,7 +390,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
+rubygems_version: 3.5.6
 signing_key:
 specification_version: 4
 summary: Library for stubbing HTTP requests in Ruby.