falcon 0.43.0 → 0.45.0

data/lib/falcon/environments/application.rb

@@ -1,56 +0,0 @@
-# frozen_string_literal: true
-
-# Released under the MIT License.
-# Copyright, 2019-2023, by Samuel Williams.
-# Copyright, 2020, by Daniel Evans.
-
-require_relative '../proxy_endpoint'
-require_relative '../server'
-
-require_relative '../service/application'
-
-# A general application environment.
-# Suitable for use with any {Protocol::HTTP::Middleware}.
-#
-# @scope Falcon Environments
-# @name application
-environment(:application) do
-	# The middleware stack for the application.
-	# @attribute [Protocol::HTTP::Middleware]
-	middleware do
-		::Protocol::HTTP::Middleware::HelloWorld
-	end
-	
-	# The scheme to use to communicate with the application.
-	# @attribute [String]
-	scheme 'https'
-	
-	# The protocol to use to communicate with the application.
-	#
-	# Typically one of {Async::HTTP::Protocol::HTTP1} or {Async::HTTP::Protocl::HTTP2}.
-	#
-	# @attribute [Async::HTTP::Protocol]
-	protocol {Async::HTTP::Protocol::HTTP2}
-	
-	# The IPC path to use for communication with the application.
-	# @attribute [String]
-	ipc_path {::File.expand_path("application.ipc", root)}
-	
-	# The endpoint that will be used for communicating with the application server.
-	# @attribute [Async::IO::Endpoint]
-	endpoint do
-		::Falcon::ProxyEndpoint.unix(ipc_path,
-			protocol: protocol,
-			scheme: scheme,
-			authority: authority
-		)
-	end
-	
-	# The service class to use for the application.
-	# @attribute [Class]
-	service ::Falcon::Service::Application
-	
-	# Number of instances to start.
-	# @attribute [Integer | nil]
-	count nil
-end

data/lib/falcon/environments/lets_encrypt_tls.rb

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-
-# Released under the MIT License.
-# Copyright, 2020-2023, by Samuel Williams.
-
-load(:tls)
-
-# A Lets Encrypt SSL context environment.
-#
-# Derived from {.tls}.
-#
-# @scope Falcon Environments
-# @name lets_encrypt_tls
-environment(:lets_encrypt_tls, :tls) do
-	# The Lets Encrypt certificate store path.
-	# @parameter [String]
-	lets_encrypt_root '/etc/letsencrypt/live'
-	
-	# The public certificate path.
-	# @attribute [String]
-	ssl_certificate_path do
-		File.join(lets_encrypt_root, authority, "fullchain.pem")
-	end
-	
-	# The private key path.
-	# @attribute [String]
-	ssl_private_key_path do
-		File.join(lets_encrypt_root, authority, "privkey.pem")
-	end
-end

data/lib/falcon/environments/proxy.rb

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-# Released under the MIT License.
-# Copyright, 2019-2023, by Samuel Williams.
-
-require_relative '../service/proxy'
-
-# A HTTP proxy environment.
-#
-# Derived from {.application}.
-#
-# @scope Falcon Environments
-# @name rack
-environment(:proxy) do
-	# The upstream endpoint that will handle incoming requests.
-	# @attribute [Async::HTTP::Endpoint]
-	endpoint {::Async::HTTP::Endpoint.parse(url)}
-	
-	# The service class to use for the proxy.
-	# @attribute [Class]
-	service ::Falcon::Service::Proxy
-end

data/lib/falcon/environments/rack.rb

@@ -1,33 +0,0 @@
-# frozen_string_literal: true
-
-# Released under the MIT License.
-# Copyright, 2019-2023, by Samuel Williams.
-
-load :application
-
-# A rack application environment.
-#
-# Derived from {.application}.
-#
-# @scope Falcon Environments
-# @name rack
-environment(:rack, :application) do
-	# The rack configuration path.
-	# @attribute [String]
-	config_path {::File.expand_path("config.ru", root)}
-	
-	# Whether to enable the application layer cache.
-	# @attribute [String]
-	cache false
-	
-	# The middleware stack for the rack application.
-	# @attribute [Protocol::HTTP::Middleware]
-	middleware do
-		app, _ = ::Rack::Builder.parse_file(config_path)
-		
-		::Falcon::Server.middleware(app,
-			verbose: verbose,
-			cache: cache
-		)
-	end
-end

data/lib/falcon/environments/self_signed_tls.rb

@@ -1,38 +0,0 @@
-# frozen_string_literal: true
-
-# Released under the MIT License.
-# Copyright, 2019-2023, by Samuel Williams.
-
-require 'localhost/authority'
-
-# A self-signed SSL context environment.
-#
-# @scope Falcon Environments
-# @name self_signed_tls
-environment(:self_signed_tls) do
-	# The default session identifier for the session cache.
-	# @attribute [String]
-	ssl_session_id {"falcon"}
-	
-	# The SSL context to use for incoming connections.
-	# @attribute [OpenSSL::SSL::SSLContext]
-	ssl_context do
-		contexts = Localhost::Authority.fetch(authority)
-		
-		contexts.server_context.tap do |context|
-			context.alpn_select_cb = lambda do |protocols|
-				if protocols.include? "h2"
-					return "h2"
-				elsif protocols.include? "http/1.1"
-					return "http/1.1"
-				elsif protocols.include? "http/1.0"
-					return "http/1.0"
-				else
-					return nil
-				end
-			end
-			
-			context.session_id_context = ssl_session_id
-		end
-	end
-end

data/lib/falcon/environments/supervisor.rb

@@ -1,34 +0,0 @@
-# frozen_string_literal: true
-
-# Released under the MIT License.
-# Copyright, 2019-2023, by Samuel Williams.
-
-require_relative '../service/supervisor'
-
-# A application process monitor environment.
-#
-# @scope Falcon Environments
-# @name supervisor
-environment(:supervisor) do
-	# The name of the supervisor
-	# @attribute [String]
-	name "supervisor"
-	
-	# The IPC path to use for communication with the supervisor.
-	# @attribute [String]
-	ipc_path do
-		::File.expand_path("supervisor.ipc", root)
-	end
-	
-	# The endpoint the supervisor will bind to.
-	# @attribute [Async::IO::Endpoint]
-	endpoint do
-		Async::IO::Endpoint.unix(ipc_path)
-	end
-	
-	# The service class to use for the supervisor.
-	# @attribute [Class]
-	service do
-		::Falcon::Service::Supervisor
-	end
-end

data/lib/falcon/environments/tls.rb

@@ -1,86 +0,0 @@
-# frozen_string_literal: true
-
-# Released under the MIT License.
-# Copyright, 2019-2023, by Samuel Williams.
-
-require_relative '../controller/proxy'
-require_relative '../tls'
-
-# A general SSL context environment.
-#
-# @scope Falcon Environments
-# @name tls
-environment(:tls) do
-	# The default session identifier for the session cache.
-	# @attribute [String]
-	ssl_session_id "falcon"
-	
-	# The supported ciphers.
-	# @attribute [Array(String)]
-	ssl_ciphers Falcon::TLS::SERVER_CIPHERS
-	
-	# The public certificate path.
-	# @attribute [String]
-	ssl_certificate_path do
-		File.expand_path("ssl/certificate.pem", root)
-	end
-	
-	# The list of certificates loaded from that path.
-	# @attribute [Array(OpenSSL::X509::Certificate)]
-	ssl_certificates do
-		OpenSSL::X509::Certificate.load_file(ssl_certificate_path)
-	end
-	
-	# The main certificate.
-	# @attribute [OpenSSL::X509::Certificate]
-	ssl_certificate {ssl_certificates[0]}
-	
-	# The certificate chain.
-	# @attribute [Array(OpenSSL::X509::Certificate)]
-	ssl_certificate_chain {ssl_certificates[1..-1]}
-	
-	# The private key path.
-	# @attribute [String]
-	ssl_private_key_path do
-		File.expand_path("ssl/private.key", root)
-	end
-	
-	# The private key.
-	# @attribute [OpenSSL::PKey::RSA]
-	ssl_private_key do
-		OpenSSL::PKey::RSA.new(File.read(ssl_private_key_path))
-	end
-	
-	# The SSL context to use for incoming connections.
-	# @attribute [OpenSSL::SSL::SSLContext]
-	ssl_context do
-		OpenSSL::SSL::SSLContext.new.tap do |context|
-			context.add_certificate(ssl_certificate, ssl_private_key, ssl_certificate_chain)
-			
-			context.session_cache_mode = OpenSSL::SSL::SSLContext::SESSION_CACHE_CLIENT
-			context.session_id_context = ssl_session_id
-			
-			context.alpn_select_cb = lambda do |protocols|
-				if protocols.include? "h2"
-					return "h2"
-				elsif protocols.include? "http/1.1"
-					return "http/1.1"
-				elsif protocols.include? "http/1.0"
-					return "http/1.0"
-				else
-					return nil
-				end
-			end
-			
-			# TODO Ruby 2.4 requires using ssl_version.
-			context.ssl_version = :TLSv1_2_server
-			
-			context.set_params(
-				ciphers: ssl_ciphers,
-				verify_mode: OpenSSL::SSL::VERIFY_NONE,
-			)
-			
-			context.setup
-		end
-	end
-end

data/lib/falcon/service/application.rb

@@ -1,99 +0,0 @@
-# frozen_string_literal: true
-
-# Released under the MIT License.
-# Copyright, 2019-2023, by Samuel Williams.
-# Copyright, 2020, by Daniel Evans.
-
-require_relative 'proxy'
-
-require 'async/http/endpoint'
-require 'async/io/shared_endpoint'
-
-module Falcon
-	module Service
-		# Implements an application server using an internal clear-text proxy.
-		class Application < Proxy
-			def initialize(environment)
-				super
-				
-				@bound_endpoint = nil
-			end
-			
-			# The middleware that will be served by this application.
-			# @returns [Protocol::HTTP::Middleware]
-			def middleware
-				# In a multi-threaded container, we don't want to modify the shared evaluator's cache, so we create a new evaluator:
-				@environment.evaluator.middleware
-			end
-			
-			# Number of instances to start.
-			# @returns [Integer | nil]
-			def count
-			  @environment.evaluator.count
-			end
-			
-			# Preload any resources specified by the environment.
-			def preload!
-				if scripts = @evaluator.preload
-					scripts.each do |path|
-						Console.logger.info(self) {"Preloading #{path}..."}
-						full_path = File.expand_path(path, self.root)
-						load(full_path)
-					end
-				end
-			end
-			
-			# Prepare the bound endpoint for the application instances.
-			# Invoke {preload!} to load shared resources into the parent process.
-			def start
-				Console.logger.info(self) {"Binding to #{self.endpoint}..."}
-				
-				@bound_endpoint = Async::Reactor.run do
-					Async::IO::SharedEndpoint.bound(self.endpoint)
-				end.wait
-				
-				preload!
-				
-				super
-			end
-			
-			# Setup instances of the application into the container.
-			# @parameter container [Async::Container::Generic]
-			def setup(container)
-				protocol = self.protocol
-				scheme = self.scheme
-				
-				run_options = {
-					name: self.name,
-					restart: true,
-				}
-				
-				run_options[:count] = count unless count.nil?
-				
-				container.run(**run_options) do |instance|
-					Async do |task|
-						Console.logger.info(self) {"Starting application server for #{self.root}..."}
-						
-						server = Server.new(self.middleware, @bound_endpoint, protocol: protocol, scheme: scheme)
-						
-						server.run
-						
-						instance.ready!
-						
-						task.children.each(&:wait)
-					end
-				end
-				
-				super
-			end
-			
-			# Close the bound endpoint.
-			def stop
-				@bound_endpoint&.close
-				@bound_endpoint = nil
-				
-				super
-			end
-		end
-	end
-end

data/lib/falcon/service/generic.rb

@@ -1,61 +0,0 @@
-# frozen_string_literal: true
-
-# Released under the MIT License.
-# Copyright, 2019-2023, by Samuel Williams.
-
-module Falcon
-	module Service
-		# Captures the stateful behaviour of a specific service.
-		# Specifies the interfaces required by derived classes.
-		#
-		# Designed to be invoked within an {Async::Controller::Container}.
-		class Generic
-			# Convert the given environment into a service if possible.
-			# @parameter environment [Build::Environment] The environment to use to construct the service.
-			def self.wrap(environment)
-				evaluator = environment.evaluator
-				service = evaluator.service || self
-				
-				return service.new(environment)
-			end
-			
-			# Initialize the service from the given environment.
-			# @parameter environment [Build::Environment]
-			def initialize(environment)
-				@environment = environment
-				@evaluator = @environment.evaluator
-			end
-			
-			# Whether the service environment contains the specified keys.
-			# This is used for matching environment configuration to service behaviour.
-			def include?(keys)
-				keys.all?{|key| @environment.include?(key)}
-			end
-			
-			# The name of the service.
-			# e.g. `myapp.com`.
-			def name
-				@evaluator.name
-			end
-			
-			# The logger to use for this service.
-			# @returns [Console::Logger]
-			def logger
-				return Console.logger # .with(name: name)
-			end
-			
-			# Start the service.
-			def start
-			end
-			
-			# Setup the service into the specified container.
-			# @parameter container [Async::Container::Generic]
-			def setup(container)
-			end
-			
-			# Stop the service.
-			def stop
-			end
-		end
-	end
-end

data/lib/falcon/service/proxy.rb

@@ -1,49 +0,0 @@
-# frozen_string_literal: true
-
-# Released under the MIT License.
-# Copyright, 2020-2023, by Samuel Williams.
-
-require_relative 'generic'
-
-require 'async/http/endpoint'
-require 'async/io/shared_endpoint'
-
-module Falcon
-	module Service
-		class Proxy < Generic
-			def name
-				"#{self.class} for #{self.authority}"
-			end
-			
-			# The host that this proxy will receive connections for.
-			def authority
-				@evaluator.authority
-			end
-			
-			# The upstream endpoint that this proxy will connect to.
-			def endpoint
-				@evaluator.endpoint
-			end
-			
-			# The {OpenSSL::SSL::SSLContext} that will be used for incoming connections.
-			def ssl_context
-				@evaluator.ssl_context
-			end
-			
-			# The root
-			def root
-				@evaluator.root
-			end
-			
-			# The protocol this proxy will use to talk to the upstream host.
-			def protocol
-				endpoint.protocol
-			end
-			
-			# The scheme this proxy will use to talk to the upstream host.
-			def scheme
-				endpoint.scheme
-			end
-		end
-	end
-end

data/lib/falcon/services.rb

@@ -1,82 +0,0 @@
-# frozen_string_literal: true
-
-# Released under the MIT License.
-# Copyright, 2019-2023, by Samuel Williams.
-
-require_relative 'service/generic'
-
-module Falcon
-	# Represents one or more services associated with a host.
-	#
-	# The services model allows falcon to manage one more more service associated with a given host. Some examples of services include:
-	#
-	# - Rack applications wrapped by {Service::Application}.
-	# - Host supervisor implemented in {Service::Supervisor}.
-	# - Proxy services wrapped by {Service::Proxy}.
-	#
-	# The list of services is typically generated from the user supplied `falcon.rb` configuration file, which is loaded into an immutable {Configuration} instance, which is mapped into a list of services.
-	class Services
-		# Initialize the services from the given configuration.
-		#
-		# @parameter configuration [Configuration]
-		def initialize(configuration)
-			@named = {}
-			
-			configuration.each(:service) do |environment|
-				service = Service::Generic.wrap(environment)
-				
-				add(service)
-			end
-		end
-		
-		# Enumerate all named services.
-		def each(&block)
-			@named.each_value(&block)
-		end
-		
-		# Add a named service.
-		#
-		# @parameter service [Service]
-		def add(service)
-			@named[service.name] = service
-		end
-		
-		# Start all named services.
-		def start
-			@named.each do |name, service|
-				Console.logger.debug(self) {"Starting #{name}..."}
-				service.start
-			end
-		end
-		
-		# Setup all named services into the given container.
-		#
-		# @parameter container [Async::Container::Generic]
-		def setup(container)
-			@named.each do |name, service|
-				Console.logger.debug(self) {"Setup #{name} into #{container}..."}
-				service.setup(container)
-			end
-			
-			return container
-		end
-		
-		# Stop all named services.
-		def stop
-			failed = false
-			
-			@named.each do |name, service|
-				Console.logger.debug(self) {"Stopping #{name}..."}
-				
-				begin
-					service.stop
-				rescue => error
-					failed = true
-					Console.logger.error(self, error)
-				end
-			end
-			
-			return failed
-		end
-	end
-end