webmock 3.21.1 → 3.22.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 00fe33740b645d6ee1a843e8a863287c784171a411e36a6a03a9964d1a0f5d1e
-  data.tar.gz: 581a52244e5ae82837eefbbc750d3785db5c465380885a865332d7c483c73acd
+  metadata.gz: ecff3692887f15d1f0e2e19df92093a40d4f6e5f7e4686d7e18ee4efaadf190f
+  data.tar.gz: 6cf4e165350b7878223e28687db13d57df6fe07d90f50a087527d5d001b305e6
 SHA512:
-  metadata.gz: 3693a98690a3c2a4e2fa32721fee8e5c4fbe7a541e33465707f99fd980bd67a57e2f31ba4f51e13121ac65302ec0d41e154bdde447053bbfd56452d8016e65e1
-  data.tar.gz: 254ba266ba69ab8edb4d48ce83c563e0fa514b778bfbf8c0a695150606e1ad954961abdb69f48a95097960681fa79db8e258f46db28ed250522de57eba8b89f2
+  metadata.gz: 566cf68fd9c0ee2de8c5e54693e0caa2b956c537f9b82362b7eb7547214349b7966029d6cf12dcac0ca930b0b0f9ad2c32c7dace3a2bd84d43eecd488b194144
+  data.tar.gz: a69faa775b378ee5108525cd431ab9bf242ac93afeb5fc351a7549aa852099fc9c84ceef4a6dccf265e7e27ed5e0894937a1abbc4fa9a641d9fb9c51c0e8ff90

data/CHANGELOG.md

@@ -1,9 +1,22 @@
 # Changelog
 
+# 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
@@ -192,7 +205,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

@@ -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
 
@@ -1195,6 +1199,9 @@ People who submitted patches and new features or suggested improvements. Many th
 * 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/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
@@ -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/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.21.1' unless defined?(::WebMock::VERSION)
+  VERSION = '3.22.0' unless defined?(::WebMock::VERSION)
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: webmock
 version: !ruby/object:Gem::Version
-  version: 3.21.1
+  version: 3.22.0
 platform: ruby
 authors:
 - Bartosz Blimke
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-02-20 00:00:00.000000000 Z
+date: 2024-02-21 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.21.1/CHANGELOG.md
-  documentation_uri: https://www.rubydoc.info/gems/webmock/3.21.1
-  source_code_uri: https://github.com/bblimke/webmock/tree/v3.21.1
+  changelog_uri: https://github.com/bblimke/webmock/blob/v3.22.0/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/gems/webmock/3.22.0
+  source_code_uri: https://github.com/bblimke/webmock/tree/v3.22.0
   wiki_uri: https://github.com/bblimke/webmock/wiki
 post_install_message:
 rdoc_options: []