async-http-faraday 0.17.0 → 0.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4c569036046b86acaf015c423fc888862d5354a33bcf6699c9d2ff9862a96a30
-  data.tar.gz: 585cebc0227475f76d7686c2291ed9fcf358423ac0b505a4d2b5fa34273a9288
+  metadata.gz: 405bbaf8e19d542be2efd5e6ba29e5dabaa0fedbbad6c392f70b70dac5295f21
+  data.tar.gz: 2ae52a3a031dea0f6c715e7144f9e0ed2872b0e9b2c8a07043ce1be49f8640a5
 SHA512:
-  metadata.gz: 3a032c25d0a49d7b02d32f93fa597ecc81562252efbf29f52ab70eafbc7b0e27ed68840118fb4b4c002ef6bc884365111ffcae3864dc8750cdf72789a5a18bae
-  data.tar.gz: 221d129c86685d6e3ed610b10403fda786f6782c8e6ae24cf7337afbf9e6c01461e2fc10e1e2964a95e49be45714bf2510560a5ca4abf3a029894a09702e5437
+  metadata.gz: 8808afa0006650011169d8a9ea52d7029e8e7032d84eceec7e2fa2046b58e66297c3a5b0166ed623b81198161e5a5830309b4db21e30e9174d69f21927bb0a6f
+  data.tar.gz: '064528fe335006b4b00ba6719c119bf583c0cfb20ebdf67d74324d98c74d1c95c3bd9d00359ae1bf80d1fdaca796203526c95473a1d392128eff66b392770dba'

data/changes.md

@@ -0,0 +1,38 @@
+# v0.18.0
+
+## Config Block
+
+The `config_block` provided to the adapter must now return `nil`, `client` or a middleware wrapper around `client`.
+
+```ruby
+Faraday.new do |builder|
+	builder.adapter :async_http do |client|
+		# Option 1 (same as returning `nil`), use client as is:
+		client # Use `client` as is.
+		
+		# Option 2, wrap client in a middleware:
+		Async::HTTP::Middleware::LocationRedirector.new(client)
+	end
+end
+```
+
+# v0.17.0
+
+## Per-thread Client Cache
+
+The default adapter now uses a per-thread client cache internally, to improve compatibility with existing code that shares a single `Faraday::Connection` instance across multiple threads.
+
+```ruby
+adapter = Faraday.new do |builder|
+	builder.adapter :async_http
+end
+
+3.times do
+	Thread.new do
+		Async do
+			# Each thread has it's own client cache.
+			adapter.get('http://example.com')
+		end
+	end
+end
+```

data/lib/async/http/faraday/adapter.rb

@@ -12,6 +12,8 @@
 
 require 'faraday'
 require 'faraday/adapter'
+
+require 'async/barrier'
 require 'kernel/sync'
 
 require 'async/http/client'
@@ -48,8 +50,47 @@ module Async
 				end
 			end
 			
+			class ParallelManager
+				def initialize(options = {})
+					@options = options
+					@barrier = nil
+				end
+				
+				def run
+					if $VERBOSE
+						warn "Please update your Faraday version!", uplevel: 2
+					end
+				end
+				
+				def async(&block)
+					if @barrier
+						@barrier.async(&block)
+					else
+						Sync(&block)
+					end
+				end
+				
+				def execute(&block)
+					Sync do
+						@barrier = Async::Barrier.new
+						
+						yield
+						
+						@barrier.wait
+					ensure
+						@barrier&.stop
+					end
+				end
+			end
+			
 			# An adapter that allows Faraday to use Async::HTTP as the underlying HTTP client.
 			class Adapter < ::Faraday::Adapter
+				self.supports_parallel = true
+				
+				def self.setup_parallel_manager(**options)
+					ParallelManager.new(options)
+				end
+				
 				# The exceptions that are considered connection errors and result in a `Faraday::ConnectionFailed` exception.
 				CONNECTION_EXCEPTIONS = [
 					Errno::EADDRNOTAVAIL,
@@ -98,6 +139,21 @@ module Async
 					# For compatibility with the default adapter:
 					env.url.path = '/' if env.url.path.empty?
 					
+					if parallel_manager = env.parallel_manager
+						parallel_manager.async do
+							perform_request(env)
+							env.response.finish(env)
+						end
+					else
+						perform_request(env)
+					end
+					
+					@app.call(env)
+				end
+				
+				private
+				
+				def perform_request(env)
 					with_client(env) do |endpoint, client|
 						if body = env.body
 							# We need to ensure the body is wrapped in a Readable object so that it can be read in chunks:
@@ -149,8 +205,6 @@ module Async
 					raise ::Faraday::ConnectionFailed, e
 				end
 				
-				private
-				
 				def with_client(env)
 					Sync do
 						endpoint = Endpoint.new(env.url)

data/lib/async/http/faraday/clients.rb

@@ -38,8 +38,8 @@ module Async
 				# @parameter endpoint [IO::Endpoint::Generic] The endpoint to create the client for.
 				def make_client(endpoint)
 					client = Client.new(endpoint, **@options)
-					@block&.call(client)
-					return client
+					
+					return @block&.call(client) || client
 				end
 				
 				# Get a client for the given endpoint.

data/lib/async/http/faraday/version.rb

@@ -6,7 +6,7 @@
 module Async
 	module HTTP
 		module Faraday
-			VERSION = "0.17.0"
+			VERSION = "0.19.0"
 		end
 	end
 end

data/readme.md

@@ -9,9 +9,21 @@ Provides an adaptor for [Faraday](https://github.com/lostisland/faraday) to perf
 
 ## Usage
 
-Please see the [project documentation](https://socketry.github.io/async-http/) for more details.
+Please see the [project documentation](https://socketry.github.io/async-http-faraday/) for more details.
 
-  - [Getting Started](https://socketry.github.io/async-http/guides/getting-started/index) - This guide explains how to use use `Async::HTTP::Faraday` as a drop-in replacement for improved concurrency.
+  - [Getting Started](https://socketry.github.io/async-http-faraday/guides/getting-started/index) - This guide explains how to use use `Async::HTTP::Faraday` as a drop-in replacement for improved concurrency.
+
+## Releases
+
+Please see the [project changes](https://socketry.github.io/async-http-faraday//changes/index) for all releases.
+
+### v0.18.0
+
+  - [Config Block](https://socketry.github.io/async-http-faraday/changes/index#config-block)
+
+### v0.17.0
+
+  - [Per-thread Client Cache](https://socketry.github.io/async-http-faraday/changes/index#per-thread-client-cache)
 
 ## Contributing
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: async-http-faraday
 version: !ruby/object:Gem::Version
-  version: 0.17.0
+  version: 0.19.0
 platform: ruby
 authors:
 - Samuel Williams
@@ -46,7 +46,7 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2024-08-13 00:00:00.000000000 Z
+date: 2024-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async-http
@@ -82,6 +82,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- changes.md
 - examples/topics.rb
 - lib/async/http/faraday.rb
 - lib/async/http/faraday/adapter.rb
@@ -90,11 +91,12 @@ files:
 - lib/async/http/faraday/version.rb
 - license.md
 - readme.md
-homepage: https://github.com/socketry/async-http
+homepage: https://github.com/socketry/async-http-faraday
 licenses:
 - MIT
 metadata:
-  documentation_uri: https://socketry.github.io/async-http/
+  documentation_uri: https://socketry.github.io/async-http-faraday/
+  funding_uri: https://github.com/sponsors/ioquatix
   source_code_uri: https://github.com/socketry/async-http.git
 post_install_message:
 rdoc_options: []