async-http 0.35.1 → 0.36.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 38d3e8fe6b2bedcd8dfc48956ba07e2f70f9be363e419887baaad5c9dab3fab5
-  data.tar.gz: c924a3f88353066264b12d485a50ef894bd8c00f574a86d9fc7884519e00e366
+  metadata.gz: b6e1e7f6525a09868ce9ad825b3b58b7b64f32c5df8ed580c8f77d575cb709f4
+  data.tar.gz: dc532ce80d64d36907a8436d22acc6be3cb0d38833b0bd99cdaf1223a1d0248b
 SHA512:
-  metadata.gz: 7c930d3851d96957c9fc905c0b00ca0e0bb4e9ffc011f66f7e38763cc6293292e2442e7d67205c8c67934dbab82828b54735a3dce3855af3be9dd221828f5684
-  data.tar.gz: b6c3e1521e69ff048ba0dd5e8b89951d360eea7881f3df7488b66f48aad1b6e35562b9d91e7f1ecffb64cf130868b639596dcc52b05404d5fbf3e2a0f6e10534
+  metadata.gz: 84dd9b7d698be6596c5658be91e05cfaa18bb17125973300e330291d05bb85fa1b3a7084a099dd7d1334d520dae5e45f71791d8c40402f6424e666b1b17c7c7e
+  data.tar.gz: 878de7d6275b62fbb1a63f3317fefaaa2e3d689f3d723f8a4d4dbe75a770503c8d52d3855ce33bb07d07a21aae146f6caf2bfb14afa2d67f8b4ae6da7bdc9d9c

data/README.md

@@ -139,6 +139,20 @@ Transfer/sec:      5.98MB
 
 According to these results, the cost of handling connections is quite high, while general throughput seems pretty decent.
 
+## Semantic Model
+
+### Scheme
+
+HTTP/1 has an implicit scheme determined by the kind of connection made to the server (either `http` or `https`), while HTTP/2 models this explicitly and the client indicates this in the request using the `:scheme` pseudo-header (typically `https`). To normalize this, `Async::HTTP::Client` and `Async::HTTP::Server` have a default scheme which is used if none is supplied.
+
+### Version
+
+HTTP/1 has an explicit version while HTTP/2 does not expose the version in any way.
+
+### Reason
+
+HTTP/1 responses contain a reason field which is largely irrelevant. HTTP/2 does not support this field.
+
 ## Contributing
 
 1. Fork it

data/async-http.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |spec|
 	spec.add_dependency("async", "~> 1.6")
 	spec.add_dependency("async-io", "~> 1.16")
 	
-	spec.add_dependency("http-protocol", "~> 0.7.0")
+	spec.add_dependency("http-protocol", "~> 0.8.0")
 	
 	# spec.add_dependency("openssl")
 	

data/examples/request.rb

@@ -19,7 +19,7 @@ Async.run do |task|
 		'accept' => 'text/html',
 	}
 	
-	request = Async::HTTP::Request.new("www.google.com", "GET", "/search?q=cats", headers)
+	request = Async::HTTP::Request.new(client.scheme, "www.google.com", "GET", "/search?q=cats", headers)
 	
 	puts "Sending request..."
 	response = client.call(request)

data/lib/async/http/accept_encoding.rb

@@ -27,8 +27,12 @@ module Async
 	module HTTP
 		# Set a valid accept-encoding header and decode the response.
 		class AcceptEncoding < Middleware
+			ACCEPT_ENCODING = 'accept-encoding'.freeze
+			CONTENT_ENCODING = 'content-encoding'.freeze
+			
 			DEFAULT_WRAPPERS = {
-				'gzip' => Body::Inflate.method(:for)
+				'gzip' => Body::Inflate.method(:for),
+				'identity' => ->(body){body},
 			}
 			
 			def initialize(app, wrappers = DEFAULT_WRAPPERS)
@@ -39,11 +43,11 @@ module Async
 			end
 			
 			def call(request)
-				request.headers['accept-encoding'] = @accept_encoding
+				request.headers[ACCEPT_ENCODING] = @accept_encoding
 				
 				response = super
 				
-				if !response.body.empty? and content_encoding = response.headers['content-encoding']
+				if !response.body.empty? and content_encoding = response.headers.delete(CONTENT_ENCODING)
 					body = response.body
 					
 					# We want to unwrap all encodings

data/lib/async/http/body/inflate.rb

@@ -36,6 +36,7 @@ module Async
 					if chunk = super
 						@input_length += chunk.bytesize
 						
+						# It's possible this triggers the stream to finish.
 						chunk = @stream.inflate(chunk)
 						
 						@output_length += chunk.bytesize
@@ -47,7 +48,11 @@ module Async
 						@stream.close
 					end
 					
-					return chunk.empty? ? nil : chunk
+					if @stream.finished? and chunk.empty?
+						return nil
+					end
+					
+					return chunk
 				end
 			end
 		end

data/lib/async/http/body/writable.rb

@@ -92,7 +92,7 @@ module Async
 				alias << write
 				
 				def inspect
-					"\#<#{self.class} #{@count} chunks written#{@finished ? ', finished' : ''}>"
+					"\#<#{self.class} #{@count} chunks written#{@finished ? ', finished' : ', waiting'}>"
 				end
 			end
 		end

data/lib/async/http/client.rb

@@ -28,23 +28,26 @@ require_relative 'middleware'
 module Async
 	module HTTP
 		class Client
-			def initialize(endpoint, protocol = endpoint.protocol, authority = endpoint.hostname, retries: 3, **options)
+			def initialize(endpoint, protocol = endpoint.protocol, scheme = endpoint.scheme, authority = endpoint.authority, retries: 3, connection_limit: nil)
 				@endpoint = endpoint
-				
 				@protocol = protocol
-				@authority = authority
 				
 				@retries = retries
-				@pool = connect(**options)
+				@pool = make_pool(connection_limit)
+				
+				@scheme = scheme
+				@authority = authority
 			end
 			
 			attr :endpoint
 			attr :protocol
-			attr :authority
 			
 			attr :retries
 			attr :pool
 			
+			attr :scheme
+			attr :authority
+			
 			def self.open(*args, &block)
 				client = self.new(*args)
 				
@@ -64,7 +67,9 @@ module Async
 			include Methods
 			
 			def call(request)
-				request.authority ||= @authority
+				request.scheme ||= self.scheme
+				request.authority ||= self.authority
+				
 				attempt = 0
 				
 				# We may retry the request if it is possible to do so. https://tools.ietf.org/html/draft-nottingham-httpbis-retry-01 is a good guide for how retrying requests should work.
@@ -105,7 +110,7 @@ module Async
 			
 			protected
 			
-			def connect(connection_limit: nil)
+			def make_pool(connection_limit = nil)
 				Pool.new(connection_limit) do
 					Async.logger.debug(self) {"Making connection to #{@endpoint.inspect}"}
 					

data/lib/async/http/internet.rb

@@ -39,7 +39,7 @@ module Async
 				
 				body = Body::Buffered.wrap(body)
 				
-				request = Request.new(endpoint.authority, method, endpoint.path, nil, headers, body)
+				request = Request.new(client.scheme, endpoint.authority, method, endpoint.path, nil, headers, body)
 				
 				return client.call(request)
 			end

data/lib/async/http/middleware.rb

@@ -32,8 +32,10 @@ module Async
 		
 		module Methods
 			VERBS.each do |verb|
-				define_method(verb.downcase) do |location, headers = [], body = []|
-					self.call(Request[verb, location.to_str, headers, body])
+				define_method(verb.downcase) do |location, headers = [], body = nil|
+					self.call(
+						Request[verb, location.to_str, headers, body]
+					)
 				end
 			end
 		end

data/lib/async/http/protocol/http1/connection.rb

@@ -31,6 +31,14 @@ module Async
 		module Protocol
 			module HTTP1
 				class Connection < ::HTTP::Protocol::HTTP1::Connection
+					def initialize(stream, version)
+						super(stream)
+						
+						@version = version
+					end
+					
+					attr :version
+					
 					CRLF = "\r\n"
 					
 					attr :stream

data/lib/async/http/protocol/http1/request.rb

@@ -26,7 +26,7 @@ module Async
 			module HTTP1
 				class Request < Protocol::Request
 					def initialize(protocol)
-						super(*protocol.read_request)
+						super(nil, *protocol.read_request)
 						
 						@protocol = protocol
 					end

data/lib/async/http/protocol/http1/server.rb

@@ -38,7 +38,7 @@ module Async
 						return request
 					rescue
 						# Bad Request
-						write_response(self.version, 400, {}, nil)
+						write_response(@version, 400, {}, nil)
 						
 						raise
 					end
@@ -51,10 +51,10 @@ module Async
 							return if @stream.closed?
 							
 							if response
-								write_response(self.version, response.status, response.headers, response.body, request.head?)
+								write_response(@version, response.status, response.headers, response.body, request.head?)
 							else
 								# If the request failed to generate a response, it was an internal server error:
-								write_response(self.version, 500, {}, nil)
+								write_response(@version, 500, {}, nil)
 							end
 							
 							# Gracefully finish reading the request body if it was not already done so.

data/lib/async/http/protocol/http1.rb

@@ -24,14 +24,17 @@ require_relative 'http1/server'
 module Async
 	module HTTP
 		module Protocol
-			# A server that supports both HTTP1.0 and HTTP1.1 semantics by detecting the version of the request.
 			module HTTP1
-				def self.client(*args)
-					Client.new(*args)
+				VERSION = "HTTP/1.1"
+				
+				def self.client(stream)
+					Client.new(stream, VERSION)
 				end
 				
-				def self.server(*args)
-					Server.new(*args)
+				# A server that supports both HTTP1.0 and HTTP1.1 semantics by detecting the version of the request.
+				# TODO Verify correct behaviour.
+				def self.server(stream)
+					Server.new(stream, VERSION)
 				end
 			end
 		end

data/lib/async/http/protocol/http2/client.rb

@@ -30,12 +30,12 @@ module Async
 				class Client < ::HTTP::Protocol::HTTP2::Client
 					include Connection
 					
-					def initialize(stream, *args)
+					def initialize(stream)
 						@stream = stream
 						
 						framer = ::HTTP::Protocol::HTTP2::Framer.new(@stream)
 						
-						super(framer, *args)
+						super(framer)
 					end
 					
 					# Used by the client to send requests to the remote server.

data/lib/async/http/protocol/http2/request.rb

@@ -29,7 +29,7 @@ module Async
 					def initialize(protocol, stream_id)
 						@input = Body::Writable.new
 						
-						super(nil, nil, nil, VERSION, Headers.new, @input)
+						super(nil, nil, nil, nil, VERSION, Headers.new, @input)
 						
 						@protocol = protocol
 						@stream = Stream.new(self, protocol, stream_id)
@@ -43,7 +43,15 @@ module Async
 					
 					def receive_headers(stream, headers, end_stream)
 						headers.each do |key, value|
-							if key == METHOD
+							if key == SCHEME
+								return @stream.send_failure(400, "Request scheme already specified") if @scheme
+								
+								@scheme = value
+							elsif key == AUTHORITY
+								return @stream.send_failure(400, "Request authority already specified") if @authority
+								
+								@authority = value
+							elsif key == METHOD
 								return @stream.send_failure(400, "Request method already specified") if @method
 								
 								@method = value
@@ -51,10 +59,6 @@ module Async
 								return @stream.send_failure(400, "Request path already specified") if @path
 								
 								@path = value
-							elsif key == AUTHORITY
-								return @stream.send_failure(400, "Request authority already specified") if @authority
-								
-								@authority = value
 							else
 								@headers[key] = value
 							end

data/lib/async/http/protocol/http2/response.rb

@@ -38,6 +38,15 @@ module Async
 						@exception = nil
 					end
 					
+					# Notify anyone waiting on the response headers to be received (or failure).
+					protected def notify!
+						if @notification
+							@notification.signal
+							@notification = nil
+						end
+					end
+					
+					# Wait for the headers to be received or for stream reset.
 					def wait
 						# If you call wait after the headers were already received, it should return immediately.
 						if @notification
@@ -67,11 +76,7 @@ module Async
 							@body = @input = Body::Writable.new(@length)
 						end
 						
-						# We are ready for processing:
-						if @notification
-							@notification.signal
-							@notification = nil
-						end
+						notify!
 					end
 					
 					def receive_data(stream, data, end_stream)
@@ -88,10 +93,10 @@ module Async
 					
 					def receive_reset_stream(stream, error_code)
 						if error_code > 0
-							@exception = EOFError.new(error_code)
+							@exception = EOFError.new("Stream reset: error_code=#{error_code}")
 						end
 						
-						@notification.signal
+						notify!
 					end
 					
 					# Send a request and read it into this response.
@@ -99,7 +104,7 @@ module Async
 						# https://http2.github.io/http2-spec/#rfc.section.8.1.2.3
 						# All HTTP/2 requests MUST include exactly one valid value for the :method, :scheme, and :path pseudo-header fields, unless it is a CONNECT request (Section 8.3). An HTTP request that omits mandatory pseudo-header fields is malformed (Section 8.1.2.6).
 						pseudo_headers = [
-							[SCHEME, HTTPS],
+							[SCHEME, request.scheme],
 							[METHOD, request.method],
 							[PATH, request.path],
 						]

data/lib/async/http/protocol/http2/server.rb

@@ -30,12 +30,12 @@ module Async
 				class Server < ::HTTP::Protocol::HTTP2::Server
 					include Connection
 					
-					def initialize(stream, *args)
+					def initialize(stream)
 						@stream = stream
 						
 						framer = ::HTTP::Protocol::HTTP2::Framer.new(stream)
 						
-						super(framer, *args)
+						super(framer)
 						
 						@requests = Async::Queue.new
 					end

data/lib/async/http/request.rb

@@ -27,7 +27,8 @@ module Async
 		class Request
 			prepend Body::Reader
 			
-			def initialize(authority = nil, method = nil, path = nil, version = nil, headers = [], body = nil)
+			def initialize(scheme = nil, authority = nil, method = nil, path = nil, version = nil, headers = [], body = nil)
+				@scheme = scheme
 				@authority = authority
 				@method = method
 				@path = path
@@ -36,6 +37,7 @@ module Async
 				@body = body
 			end
 			
+			attr_accessor :scheme
 			attr_accessor :authority
 			attr_accessor :method
 			attr_accessor :path
@@ -54,7 +56,7 @@ module Async
 			def self.[](method, path, headers, body)
 				body = Body::Buffered.wrap(body)
 				
-				self.new(nil, method, path, nil, headers, body)
+				self.new(nil, nil, method, path, nil, headers, body)
 			end
 			
 			def idempotent?
@@ -64,6 +66,10 @@ module Async
 			def to_s
 				"#{@method} #{@path} #{@version}"
 			end
+			
+			def inspect
+				"\#<#{self.class} #{self.to_s} scheme=#{@scheme.inspect} authority=#{@authority.inspect} headers=#{@headers.to_h.inspect} body=#{@body.inspect}>"
+			end
 		end
 	end
 end

data/lib/async/http/server.rb

@@ -31,23 +31,32 @@ module Async
 				self.new(block, *args)
 			end
 			
-			def initialize(app, endpoint, protocol_class = nil)
+			def initialize(app, endpoint, protocol = endpoint.protocol, scheme = endpoint.scheme)
 				super(app)
 				
 				@endpoint = endpoint
-				@protocol_class = protocol_class || endpoint.protocol
+				@protocol = protocol
+				@scheme = scheme
 			end
 			
+			attr :scheme
+			
 			def accept(peer, address, task: Task.current)
 				peer.setsockopt(Socket::IPPROTO_TCP, Socket::TCP_NODELAY, 1)
 				
 				stream = Async::IO::Stream.new(peer)
-				protocol = @protocol_class.server(stream)
+				protocol = @protocol.server(stream)
 				
 				Async.logger.debug(self) {"Incoming connnection from #{address.inspect} to #{protocol}"}
 				
 				protocol.each do |request|
+					# We set the default scheme unless it was otherwise specified.
+					# https://tools.ietf.org/html/rfc7230#section-5.5
+					request.scheme ||= self.scheme
+					
+					# This is a slight optimization to avoid having to get the address from the socket.
 					request.remote_address = address
+					
 					# Async.logger.debug(self) {"Incoming request from #{address.inspect}: #{request.method} #{request.path}"}
 					
 					# If this returns nil, we assume that the connection has been hijacked.

data/lib/async/http/url_endpoint.rb

@@ -82,6 +82,10 @@ module Async
 				@options[:hostname] || @url.hostname
 			end
 			
+			def scheme
+				@options[:scheme] || @url.scheme
+			end
+			
 			def authority
 				if default_port?
 					hostname

data/lib/async/http/version.rb

@@ -20,6 +20,6 @@
 
 module Async
 	module HTTP
-		VERSION = "0.35.1"
+		VERSION = "0.36.0"
 	end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: async-http
 version: !ruby/object:Gem::Version
-  version: 0.35.1
+  version: 0.36.0
 platform: ruby
 authors:
 - Samuel Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-25 00:00:00.000000000 Z
+date: 2018-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.0
+        version: 0.8.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.0
+        version: 0.8.0
 - !ruby/object:Gem::Dependency
   name: async-rspec
   requirement: !ruby/object:Gem::Requirement