falcon 0.27.0 → 0.28.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5d8f6d04def38b5f391b3cdcc17935b06612a9c95137bfaf563c58ac21cc0edc
-  data.tar.gz: '085234503af9930b2d0a9bf7430673bb896456c2093cc627eee83fb7a6d9e1a3'
+  metadata.gz: 93cb18cb7157a7f267220d2d81a93d3c28bd96efddc04f799f64bdb658f9fa6b
+  data.tar.gz: efba9da82250f426f87705588d1601e0e6a349d1879a07b1fd18d7130f4a1091
 SHA512:
-  metadata.gz: 41223e695feb4428ef06b260dd4b4a178c35f8889708198f5f94f4f598b6322b2c0d431e0268372debe54fd670fdb146efa2126295d8022a956a4878dd9ce095
-  data.tar.gz: 33728e72a25355cb7025b0ae1c4f4883fc200251d82fe8d7ee1011c240ec9f49769c601a95da80801736a6cfeb3c1f78f3d499ac9c013425cc82c27c90987016
+  metadata.gz: f076c28cf4e3012624f56e775f27403bcd36aca3bf6c2f30120ce3c3fe60476a2cc1f68d2e64f235b66b51e9d08219d5242ec993b53a32e65e6e187dce991187
+  data.tar.gz: ae523db0420b3b8408ed84d9d6f99ae4ab6cabd0672699ed81c0d89a866aeed157d6b14984ce72ce8bd2bf930a074d5e702b4f4dfc74c73113eb9d2e2fb408b7

data/README.md

@@ -42,7 +42,7 @@ Alternatively, install in terminal:
 
 ## Usage
 
-You can run `falcon serve` directly. It will load the `config.ru` and start serving on https://localhost:9292.
+You can run `falcon serve` directly. It will load the `config.ru` and start serving on https://localhost:9292. Please [try the interactive online tutorial](https://katacoda.com/ioquatix/scenarios/falcon-introduction).
 
 The `falcon serve` command has the following options for you to use:
 

data/falcon.gemspec

@@ -16,10 +16,10 @@ Gem::Specification.new do |spec|
 	spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
 	spec.require_paths = ["lib"]
 
-	spec.add_dependency "http-protocol", "~> 0.15"
+	spec.add_dependency "http-protocol", "~> 0.17"
 	
 	spec.add_dependency "async", "~> 1.13"
-	spec.add_dependency "async-io", "~> 1.20"
+	spec.add_dependency "async-io", "~> 1.22"
 	spec.add_dependency "async-http", "~> 0.38.0"
 	spec.add_dependency "async-container", "~> 0.10.0"
 	

data/lib/falcon/adapters/hijack.rb

@@ -0,0 +1,90 @@
+# Copyright, 2019, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+require 'async/http/middleware'
+require 'async/io/buffer'
+
+module Falcon
+	module Adapters
+		# This is used for implementing partial hijack.
+		class Hijack
+			def self.for(env, block, socket = nil, task: Async::Task.current)
+				input = env[Rack::RACK_INPUT]
+				output = Async::HTTP::Body::Writable.new
+				
+				stream = Hijack.new(input, output, socket)
+				
+				task.async do
+					begin
+						block.call(stream)
+					ensure
+						stream.close
+					end
+				end
+				
+				return output
+			end
+			
+			def initialize(input, output, socket)
+				@input = input
+				@output = output
+				@socket = socket
+				@closed = false
+			end
+			
+			def read(length = nil, buffer = nil)
+				@input.read(length, buffer)
+			end
+			
+			def read_nonblock(length, buffer = nil)
+				@input.read(length, buffer)
+			end
+			
+			def write(buffer)
+				@output.write(buffer)
+			end
+			
+			alias write_nonblock write
+			
+			def flush
+			end
+			
+			def close
+				return if @closed
+				
+				@input.close
+				@output.close
+				@closed = true
+			end
+			
+			def close_read
+				@input.close
+			end
+			
+			def close_write
+				@output.close
+			end
+			
+			def closed?
+				@closed
+			end
+		end
+	end
+end

data/lib/falcon/adapters/rack.rb

@@ -23,6 +23,7 @@ require 'rack'
 require_relative 'input'
 require_relative 'response'
 require_relative 'early_hints'
+require_relative 'hijack'
 
 require 'async/logger'
 
@@ -111,12 +112,6 @@ module Falcon
 				end
 			end
 			
-			def make_response(request, status, headers, body)
-				# @logger.debug(request) {"Rack response: #{status} #{headers.inspect} #{body.class}"}
-				
-				return Response.wrap(status, headers, body)
-			end
-			
 			def call(request)
 				request_path, query_string = request.path.split('?', 2)
 				server_name, server_port = (request.authority || '').split(':', 2)
@@ -157,6 +152,9 @@ module Falcon
 					# I'm not sure what sane defaults should be here:
 					SERVER_NAME => server_name || '',
 					SERVER_PORT => server_port || '',
+					
+					# We support both request and response hijack.
+					RACK_IS_HIJACK => true,
 				}
 				
 				self.unwrap_request(request, env)
@@ -165,11 +163,12 @@ module Falcon
 					env[RACK_EARLY_HINTS] = EarlyHints.new(request)
 				end
 				
+				full_hijack = false
+				
 				if request.hijack?
-					env[RACK_IS_HIJACK] = true
-					
 					env[RACK_HIJACK] = lambda do
-						wrapper = request.hijack
+						wrapper = request.hijack!
+						full_hijack = true
 						
 						# We dup this as it might be taken out of the normal control flow, and the io will be closed shortly after returning from this method.
 						io = wrapper.io.dup
@@ -178,27 +177,16 @@ module Falcon
 						# This is implicitly returned:
 						env[RACK_HIJACK_IO] = io
 					end
-				else
-					env[RACK_IS_HIJACK] = false
 				end
 				
 				status, headers, body = @app.call(env)
 				
-				# Partial hijack is not supported/tested.
-				# if hijack = headers.delete('rack.hijack')
-				# 	body = Async::HTTP::Body::Writable.new
-				# 
-				# 	Task.current.async do
-				# 		hijack.call(body)
-				# 	end
-				# 	return nil
-				# end
-				
-				# if env['rack.hijack_io']
-				# 	return nil
-				# end
-				
-				return make_response(request, status, headers, body)
+				# If there was a full hijack:
+				if full_hijack
+					return nil
+				else
+					return Response.wrap(status, headers, body, request, env)
+				end
 			rescue => exception
 				@logger.error(self) {exception}
 				

data/lib/falcon/adapters/response.rb

@@ -19,6 +19,7 @@
 # THE SOFTWARE.
 
 require_relative 'output'
+require_relative 'hijack'
 require_relative '../version'
 require_relative '../proxy'
 
@@ -27,20 +28,18 @@ require 'time'
 module Falcon
 	module Adapters
 		class Response < Async::HTTP::Response
-			IGNORE_HEADERS = Set.new(Proxy::HOP_HEADERS)
+			IGNORE_HEADERS = Proxy::HOP_HEADERS
 			
 			# Append a list of newline encoded headers.
 			def self.wrap_headers(fields)
 				headers = ::HTTP::Protocol::Headers.new
+				meta = {}
 				
 				fields.each do |key, value|
-					next if key.start_with? 'rack.'
-					
-					# This is a quick fix, but perhaps it should be part of the protocol, because it IS valid for HTTP/1.
 					key = key.downcase
 					
-					if IGNORE_HEADERS.include? key
-						Async.logger.warn("Ignoring protocol-level header: #{key}: #{value}!")
+					if key.start_with?('rack.')
+						meta[key] = value
 					else
 						value.to_s.split("\n").each do |part|
 							headers.add(key, part)
@@ -48,11 +47,23 @@ module Falcon
 					end
 				end
 				
-				return headers
+				return headers, meta
 			end
 			
-			def self.wrap(status, headers, body)
-				headers = wrap_headers(headers)
+			def self.wrap(status, headers, body, request = nil, env = nil)
+				headers, meta = wrap_headers(headers)
+				
+				if block = meta['rack.hijack'] and request and env
+					body = Hijack.for(env, block, request.hijack? ? request.hijack! : nil)
+				else
+					sliced = headers.slice!(IGNORE_HEADERS)
+					
+					unless sliced.empty?
+						Async.logger.warn("Ignoring protocol-level headers: #{sliced.inspect}")
+					end
+					
+					body = Output.wrap(status, headers, body)
+				end
 				
 				# https://tools.ietf.org/html/rfc7231#section-7.4.2
 				# headers.add('server', "falcon/#{Falcon::VERSION}")
@@ -60,8 +71,6 @@ module Falcon
 				# https://tools.ietf.org/html/rfc7231#section-7.1.1.2
 				# headers.add('date', Time.now.httpdate)
 				
-				body = Output.wrap(status, headers, body)
-				
 				return self.new(status, headers, body)
 			end
 			

data/lib/falcon/version.rb

@@ -19,5 +19,5 @@
 # THE SOFTWARE.
 
 module Falcon
-	VERSION = "0.27.0"
+	VERSION = "0.28.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: falcon
 version: !ruby/object:Gem::Version
-  version: 0.27.0
+  version: 0.28.0
 platform: ruby
 authors:
 - Samuel Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-26 00:00:00.000000000 Z
+date: 2019-05-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http-protocol
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.15'
+        version: '0.17'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.15'
+        version: '0.17'
 - !ruby/object:Gem::Dependency
   name: async
   requirement: !ruby/object:Gem::Requirement
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.20'
+        version: '1.22'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.20'
+        version: '1.22'
 - !ruby/object:Gem::Dependency
   name: async-http
   requirement: !ruby/object:Gem::Requirement
@@ -282,6 +282,7 @@ files:
 - gems/rack3.gemfile
 - lib/falcon.rb
 - lib/falcon/adapters/early_hints.rb
+- lib/falcon/adapters/hijack.rb
 - lib/falcon/adapters/input.rb
 - lib/falcon/adapters/output.rb
 - lib/falcon/adapters/rack.rb
@@ -321,7 +322,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.2
 signing_key: 
 specification_version: 4
 summary: A fast, asynchronous, rack-compatible web server.