falcon 0.34.5 → 0.35.0

data/lib/falcon/middleware/proxy.rb

@@ -0,0 +1,143 @@
+# Copyright, 2018, 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/client'
+require 'protocol/http/headers'
+require 'protocol/http/middleware'
+
+module Falcon
+	module Middleware
+		module BadRequest
+			def self.call(request)
+				return Protocol::HTTP::Response[400, {}, []]
+			end
+			
+			def self.close
+			end
+		end
+		
+		class Proxy < Protocol::HTTP::Middleware
+			FORWARDED = 'forwarded'.freeze
+			X_FORWARDED_FOR = 'x-forwarded-for'.freeze
+			X_FORWARDED_PROTO = 'x-forwarded-proto'.freeze
+			
+			VIA = 'via'.freeze
+			CONNECTION = 'connection'.freeze
+			
+			HOP_HEADERS = [
+				'connection',
+				'keep-alive',
+				'public',
+				'proxy-authenticate',
+				'transfer-encoding',
+				'upgrade',
+			]
+			
+			def initialize(app, hosts)
+				super(app)
+				
+				@server_context = nil
+				
+				@hosts = hosts
+				@clients = {}
+				
+				@count = 0
+			end
+			
+			attr :count
+			
+			def close
+				@clients.each_value(&:close)
+				
+				super
+			end
+			
+			def connect(endpoint)
+				@clients[endpoint] ||= Async::HTTP::Client.new(endpoint)
+			end
+			
+			def lookup(request)
+				# Trailing dot and port is ignored/normalized.
+				if authority = request.authority&.sub(/(\.)?(:\d+)?$/, '')
+					return @hosts[authority]
+				end
+			end
+			
+			def prepare_headers(headers)
+				if connection = headers[CONNECTION]
+					headers.extract(connection)
+				end
+				
+				headers.extract(HOP_HEADERS)
+			end
+			
+			def prepare_request(request, host)
+				forwarded = []
+				
+				Async.logger.debug(self) do |buffer|
+					buffer.puts "Request authority: #{request.authority}"
+					buffer.puts "Host authority: #{host.authority}"
+					buffer.puts "Request: #{request.method} #{request.path} #{request.version}"
+					buffer.puts "Request headers: #{request.headers.inspect}"
+				end
+				
+				# The authority of the request must match the authority of the endpoint we are proxying to, otherwise SNI and other things won't work correctly.
+				request.authority = host.authority
+				
+				if address = request.remote_address
+					request.headers.add(X_FORWARDED_FOR, address.ip_address)
+					forwarded << "for=#{address.ip_address}"
+				end
+				
+				if scheme = request.scheme
+					request.headers.add(X_FORWARDED_PROTO, scheme)
+					forwarded << "proto=#{scheme}"
+				end
+				
+				unless forwarded.empty?
+					request.headers.add(FORWARDED, forwarded.join(';'))
+				end
+				
+				request.headers.add(VIA, "#{request.version} #{self.class}")
+				
+				self.prepare_headers(request.headers)
+				
+				return request
+			end
+			
+			def call(request)
+				if host = lookup(request)
+					@count += 1
+					
+					request = self.prepare_request(request, host)
+					
+					client = connect(host.endpoint)
+					
+					client.call(request)
+				else
+					super
+				end
+			rescue
+				Async.logger.error(self) {$!}
+				return Protocol::HTTP::Response[502, {'content-type' => 'text/plain'}, ["#{$!.inspect}: #{$!.backtrace.join("\n")}"]]
+			end
+		end
+	end
+end

data/lib/falcon/{redirection.rb → middleware/redirect.rb}

@@ -21,41 +21,43 @@
 require 'async/http/client'
 
 module Falcon
-	module NotFound
-		def self.call(request)
-			return Protocol::HTTP::Response[404, {}, []]
-		end
-		
-		def self.close
-		end
-	end
-	
-	class Redirection < Protocol::HTTP::Middleware
-		def initialize(app, hosts, endpoint)
-			super(app)
+	module Middleware
+		module NotFound
+			def self.call(request)
+				return Protocol::HTTP::Response[404, {}, []]
+			end
 			
-			@hosts = hosts
-			@endpoint = endpoint
-		end
-		
-		def lookup(request)
-			# Trailing dot and port is ignored/normalized.
-			if authority = request.authority&.sub(/(\.)?(:\d+)?$/, '')
-				return @hosts[authority]
+			def self.close
 			end
 		end
 		
-		def call(request)
-			if host = lookup(request)
-				if @endpoint.default_port?
-					location = "#{@endpoint.scheme}://#{host.authority}#{request.path}"
+		class Redirect < Protocol::HTTP::Middleware
+			def initialize(app, hosts, endpoint)
+				super(app)
+				
+				@hosts = hosts
+				@endpoint = endpoint
+			end
+			
+			def lookup(request)
+				# Trailing dot and port is ignored/normalized.
+				if authority = request.authority&.sub(/(\.)?(:\d+)?$/, '')
+					return @hosts[authority]
+				end
+			end
+			
+			def call(request)
+				if host = lookup(request)
+					if @endpoint.default_port?
+						location = "#{@endpoint.scheme}://#{host.authority}#{request.path}"
+					else
+						location = "#{@endpoint.scheme}://#{host.authority}:#{@endpoint.port}#{request.path}"
+					end
+					
+					return Protocol::HTTP::Response[301, [['location', location]], []]
 				else
-					location = "#{@endpoint.scheme}://#{host.authority}:#{@endpoint.port}#{request.path}"
+					super
 				end
-				
-				return Protocol::HTTP::Response[301, [['location', location]], []]
-			else
-				super
 			end
 		end
 	end

data/lib/falcon/proxy_endpoint.rb

@@ -58,7 +58,7 @@ module Falcon
 			return to_enum unless block_given?
 			
 			@endpoint.each do |endpoint|
-				yield self.class.new(endpoint, @options)
+				yield self.class.new(endpoint, **@options)
 			end
 		end
 		

data/lib/falcon/service/application.rb

@@ -0,0 +1,113 @@
+# Copyright, 2018, 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_relative 'generic'
+
+require 'async/http/endpoint'
+require 'async/io/shared_endpoint'
+
+module Falcon
+	module Service
+		class Application < Generic
+			def initialize(environment)
+				super
+				
+				@bound_endpoint = nil
+			end
+			
+			def name
+				"#{self.class} for #{self.authority}"
+			end
+			
+			def authority
+				@evaluator.authority
+			end
+			
+			def endpoint
+				@evaluator.endpoint
+			end
+			
+			def ssl_context
+				@evaluator.ssl_context
+			end
+			
+			def root
+				@evaluator.root
+			end
+			
+			def middleware
+				@evaluator.middleware
+			end
+			
+			def protocol
+				endpoint.protocol
+			end
+			
+			def scheme
+				endpoint.scheme
+			end
+			
+			def preload!
+				if scripts = @evaluator.preload
+					scripts.each do |path|
+						Async.logger.info(self) {"Preloading #{path}..."}
+						full_path = File.expand_path(path, self.root)
+						load(full_path)
+					end
+				end
+			end
+			
+			def to_s
+				"#{self.class} #{@evaluator.authority}"
+			end
+			
+			def start
+				Async.logger.info(self) {"Binding to #{self.endpoint}..."}
+				
+				@bound_endpoint = Async::Reactor.run do
+					Async::IO::SharedEndpoint.bound(self.endpoint)
+				end.wait
+				
+				preload!
+			end
+			
+			def setup(container)
+				container.run(name: self.name, restart: true) do |instance|
+					Async(logger: logger) do |task|
+						Async.logger.info(self) {"Starting application server for #{self.root}..."}
+						
+						server = Server.new(self.middleware, @bound_endpoint, self.protocol, self.scheme)
+						
+						server.run
+						
+						instance.ready!
+						
+						task.children.each(&:wait)
+					end
+				end
+			end
+			
+			def stop
+				@bound_endpoint&.close
+				@bound_endpoint = nil
+			end
+		end
+	end
+end

data/lib/falcon/service/generic.rb

@@ -0,0 +1,53 @@
+# Copyright, 201, 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.
+
+module Falcon
+	module Service
+		class Generic
+			def self.wrap(environment)
+				evaluator = environment.evaluator
+				service = evaluator.service || self
+				
+				return service.new(environment)
+			end
+			
+			def initialize(environment)
+				@environment = environment
+				@evaluator = @environment.evaluator
+			end
+			
+			def include?(keys)
+				keys.all?{|key| @environment.include?(key)}
+			end
+			
+			def name
+				@evaluator.name
+			end
+			
+			def logger
+				return Async.logger # .with(name: name)
+			end
+			
+			def to_s
+				self.class.name
+			end
+		end
+	end
+end

data/lib/falcon/service/supervisor.rb

@@ -0,0 +1,95 @@
+# Copyright, 2018, 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/io/endpoint'
+require 'process/metrics'
+require 'json'
+
+module Falcon
+	module Service
+		class Supervisor < Generic
+			def initialize(environment)
+				super
+				
+				@bound_endpoint = nil
+			end
+			
+			def endpoint
+				@evaluator.endpoint
+			end
+			
+			def do_restart(message)
+				# Tell the parent of this process group to spin up a new process group/container.
+				# Wait for that to start accepting new connections.
+				# Stop accepting connections.
+				# Wait for existing connnections to drain.
+				# Terminate this process group.
+				
+				signal = message[:signal] || :INT
+				
+				# Sepukku:
+				Process.kill(signal, -Process.getpgrp)
+			end
+			
+			def do_metrics(message)
+				Process::Metrics.capture(pid: Process.ppid, ppid: Process.ppid)
+			end
+			
+			def handle(message)
+				case message[:please]
+				when 'restart'
+					self.do_restart(message)
+				when 'metrics'
+					self.do_metrics(message)
+				end
+			end
+			
+			def start
+				Async.logger.info(self) {"Binding to #{self.endpoint}..."}
+				
+				@bound_endpoint = Async::Reactor.run do
+					Async::IO::SharedEndpoint.bound(self.endpoint)
+				end.wait
+			end
+			
+			def setup(container)
+				container.run(name: self.name, restart: true, count: 1) do |instance|
+					Async do
+						@bound_endpoint.accept do |peer|
+							stream = Async::IO::Stream.new(peer)
+							
+							while message = stream.gets("\0")
+								response = handle(JSON.parse(message, symbolize_names: true))
+								stream.puts(response.to_json, separator: "\0")
+							end
+						end
+						
+						instance.ready!
+					end
+				end
+			end
+			
+			def stop
+				@bound_endpoint&.close
+				@bound_endpoint = nil
+			end
+		end
+	end
+end