falcon 0.43.0 → 0.44.0

data/lib/falcon/{controller → service}/virtual.rb

@@ -1,25 +1,76 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2020-2023, by Samuel Williams.
+# Copyright, 2024, by Samuel Williams.
 
-require 'async/container/controller'
+require 'async/service/generic'
 
 module Falcon
-	module Controller
+	module Service
 		# A controller which mananages several virtual hosts.
 		# Spawns instances of {Proxy} and {Redirect} to handle incoming requests.
 		#
 		# A virtual host is an application bound to a specific authority (essentially a hostname). The virtual controller manages multiple hosts and allows a single server to host multiple applications easily.
-		class Virtual < Async::Container::Controller
-			# Initialize the virtual controller.
-			# @parameter command [Command::Virtual] The user-specified command-line options.
-			def initialize(command, **options)
-				@command = command
+		class Virtual < Async::Service::Generic
+			module Environment
+				# The service class to use for the virtual host.
+				# @returns [Class]
+				def service_class
+					Virtual
+				end
+				
+				def name
+					service_class.name
+				end
+				
+				# All the falcon application configuration paths.
+				# @returns [Array(String)] Paths to the falcon application configuration files.
+				def configuration_paths
+					["/srv/http/*/falcon.rb"]
+				end
 				
-				super(**options)
+				def configuration
+					::Async::Service::Configuration.load(configuration_paths)
+				end
+				
+				# The URI to bind the `HTTPS` -> `falcon host` proxy.
+				def bind_secure
+					"https://[::]:443"
+				end
+				
+				# The URI to bind the `HTTP` -> `HTTPS` redirector.
+				def bind_insecure
+					"http://[::]:80"
+				end
 				
-				trap(SIGHUP, &self.method(:reload))
+				# The connection timeout to use for incoming connections.
+				def timeout
+					10.0
+				end
+				
+				# # The insecure endpoint for connecting to the {Redirect} instance.
+				# def insecure_endpoint(**options)
+				# 	Async::HTTP::Endpoint.parse(bind_insecure, **options)
+				# end
+				
+				# # The secure endpoint for connecting to the {Proxy} instance.
+				# def secure_endpoint(**options)
+				# 	Async::HTTP::Endpoint.parse(bind_secure, **options)
+				# end
+				
+				# # An endpoint suitable for connecting to the specified hostname.
+				# def host_endpoint(hostname, **options)
+				# 	endpoint = secure_endpoint(**options)
+					
+				# 	url = URI.parse(bind_secure)
+				# 	url.hostname = hostname
+					
+				# 	return Async::HTTP::Endpoint.new(url, hostname: endpoint.hostname)
+				# end
+			end
+			
+			def self.included(target)
+				target.include(Environnment)
 			end
 			
 			# Drop privileges according to the user and group of the specified path.
@@ -70,7 +121,9 @@ module Falcon
 				end
 				
 				container.reload do
-					@command.resolved_paths do |path|
+					evaluator = @environment.evaluator
+					
+					evaluator.configuration_paths.each do |path|
 						path = File.expand_path(path)
 						root = File.dirname(path)
 						
@@ -79,18 +132,18 @@ module Falcon
 					
 					container.spawn(name: "Falcon Redirector", restart: true, key: :redirect) do |instance|
 						instance.exec(falcon_path, "redirect",
-							"--bind", @command.bind_insecure,
-							"--timeout", @command.timeout.to_s,
-							"--redirect", @command.bind_secure,
-							*@command.paths, ready: false
+							"--bind", evaluator.bind_insecure,
+							"--timeout", evaluator.timeout.to_s,
+							"--redirect", evaluator.bind_secure,
+							*evaluator.configuration_paths, ready: false
 						)
 					end
 					
 					container.spawn(name: "Falcon Proxy", restart: true, key: :proxy) do |instance|
 						instance.exec(falcon_path, "proxy",
-							"--bind", @command.bind_secure,
-							"--timeout", @command.timeout.to_s,
-							*@command.paths, ready: false
+							"--bind", evaluator.bind_secure,
+							"--timeout", evaluator.timeout.to_s,
+							*evaluator.configuration_paths, ready: false
 						)
 					end
 				end

data/lib/falcon/version.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2017-2023, by Samuel Williams.
+# Copyright, 2017-2024, by Samuel Williams.
 
 module Falcon
-	VERSION = "0.43.0"
+	VERSION = "0.44.0"
 end

data/license.md

@@ -19,6 +19,8 @@ Copyright, 2021, by Olle Jonsson.
 Copyright, 2023, by Nick Janetakis.  
 Copyright, 2024, by Peter Schrammel.  
 Copyright, 2024, by Santiago Bartesaghi.  
+Copyright, 2024, by Trevor Turk.  
+Copyright, 2024, by dependabot[bot].  
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: falcon
 version: !ruby/object:Gem::Version
-  version: 0.43.0
+  version: 0.44.0
 platform: ruby
 authors:
 - Samuel Williams
@@ -11,6 +11,7 @@ authors:
 - Kyle Tam
 - Mitsutaka Mimura
 - Sho Ito
+- Trevor Turk
 - Colby Swandale
 - Daniel Evans
 - Kent Gruber
@@ -23,6 +24,7 @@ authors:
 - Sh Lin
 - Tad Thorley
 - Tasos Latsas
+- dependabot[bot]
 autorequire:
 bindir: bin
 cert_chain:
@@ -55,7 +57,7 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2024-01-31 00:00:00.000000000 Z
+date: 2024-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async
@@ -77,14 +79,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.16.0
+        version: '0.17'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.16.0
+        version: '0.17'
 - !ruby/object:Gem::Dependency
   name: async-http
   requirement: !ruby/object:Gem::Requirement
@@ -128,19 +130,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.22'
 - !ruby/object:Gem::Dependency
-  name: build-environment
+  name: async-service
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: 0.10.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: 0.10.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -236,7 +238,7 @@ files:
 - bake/falcon/supervisor.rb
 - bin/falcon
 - bin/falcon-host
-- lib/.DS_Store
+- changes.md
 - lib/falcon.rb
 - lib/falcon/command.rb
 - lib/falcon/command/host.rb
@@ -248,31 +250,27 @@ files:
 - lib/falcon/command/top.rb
 - lib/falcon/command/virtual.rb
 - lib/falcon/configuration.rb
-- lib/falcon/controller/host.rb
-- lib/falcon/controller/proxy.rb
-- lib/falcon/controller/redirect.rb
-- lib/falcon/controller/serve.rb
-- lib/falcon/controller/virtual.rb
 - lib/falcon/endpoint.rb
-- lib/falcon/environments.rb
-- lib/falcon/environments/application.rb
-- lib/falcon/environments/lets_encrypt_tls.rb
-- lib/falcon/environments/proxy.rb
-- lib/falcon/environments/rack.rb
-- lib/falcon/environments/self_signed_tls.rb
-- lib/falcon/environments/supervisor.rb
-- lib/falcon/environments/tls.rb
+- lib/falcon/environment.rb
+- lib/falcon/environment/application.rb
+- lib/falcon/environment/lets_encrypt_tls.rb
+- lib/falcon/environment/proxy.rb
+- lib/falcon/environment/rack.rb
+- lib/falcon/environment/rackup.rb
+- lib/falcon/environment/redirect.rb
+- lib/falcon/environment/self_signed_tls.rb
+- lib/falcon/environment/server.rb
+- lib/falcon/environment/supervisor.rb
+- lib/falcon/environment/tls.rb
 - lib/falcon/middleware/proxy.rb
 - lib/falcon/middleware/redirect.rb
 - lib/falcon/middleware/verbose.rb
 - lib/falcon/proxy_endpoint.rb
 - lib/falcon/railtie.rb
 - lib/falcon/server.rb
-- lib/falcon/service/application.rb
-- lib/falcon/service/generic.rb
-- lib/falcon/service/proxy.rb
+- lib/falcon/service/server.rb
 - lib/falcon/service/supervisor.rb
-- lib/falcon/services.rb
+- lib/falcon/service/virtual.rb
 - lib/falcon/tls.rb
 - lib/falcon/version.rb
 - lib/rack/handler/falcon.rb
@@ -299,7 +297,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.5
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
 summary: A fast, asynchronous, rack-compatible web server.

data/lib/falcon/controller/host.rb

@@ -1,55 +0,0 @@
-# frozen_string_literal: true
-
-# Released under the MIT License.
-# Copyright, 2020-2023, by Samuel Williams.
-
-require_relative '../services'
-
-require 'async/container/controller'
-
-module Falcon
-	module Controller
-		# A generic controller for serving an application.
-		# Hosts several {Services} based on the command configuration.
-		#
-		# The configuration is provided by {Command::Host} and is typically loaded from a `falcon.rb` file. See {Configuration#load_file} for more details.
-		class Host < Async::Container::Controller
-			# Initialize the virtual controller.
-			# @parameter command [Command::Host] The user-specified command-line options.
-			def initialize(command, **options)
-				@command = command
-				
-				@configuration = command.configuration
-				@services = Services.new(@configuration)
-				
-				super(**options)
-			end
-			
-			# Create the controller as specified by the command.
-			# e.g. `Async::Container::Forked`.
-			def create_container
-				@command.container_class.new
-			end
-			
-			# Start all specified services.
-			def start
-				@services.start
-				
-				super
-			end
-			
-			# Setup all specified services into the container.
-			# @parameter container [Async::Container::Generic]
-			def setup(container)
-				@services.setup(container)
-			end
-			
-			# Stop all specified services.
-			def stop(*)
-				@services.stop
-				
-				super
-			end
-		end
-	end
-end

data/lib/falcon/controller/proxy.rb

@@ -1,109 +0,0 @@
-# frozen_string_literal: true
-
-# Released under the MIT License.
-# Copyright, 2020-2023, by Samuel Williams.
-
-require 'async/container/controller'
-
-require_relative 'serve'
-require_relative '../middleware/proxy'
-require_relative '../service/proxy'
-
-require_relative '../tls'
-
-module Falcon
-	module Controller
-		# A controller for proxying requests.
-		class Proxy < Serve
-			# The default SSL session identifier.
-			DEFAULT_SESSION_ID = "falcon"
-			
-			# Initialize the proxy controller.
-			# @parameter command [Command::Proxy] The user-specified command-line options.
-			# @parameter session_id [String] The SSL session identifier to use for the session cache.
-			def initialize(command, session_id: DEFAULT_SESSION_ID, **options)
-				super(command, **options)
-				
-				@session_id = session_id
-				@hosts = {}
-			end
-			
-			# Load the {Middleware::Proxy} application with the specified hosts.
-			def load_app
-				return Middleware::Proxy.new(Middleware::BadRequest, @hosts)
-			end
-			
-			# The name of the controller which is used for the process title.
-			def name
-				"Falcon Proxy Server"
-			end
-			
-			# Look up the host context for the given hostname, and update the socket hostname if necessary.
-			# @parameter socket [OpenSSL::SSL::SSLSocket] The incoming connection.
-			# @parameter hostname [String] The negotiated hostname.
-			def host_context(socket, hostname)
-				if host = @hosts[hostname]
-					Console.logger.debug(self) {"Resolving #{hostname} -> #{host}"}
-					
-					socket.hostname = hostname
-					
-					return host.ssl_context
-				else
-					Console.logger.warn(self) {"Unable to resolve #{hostname}!"}
-					
-					return nil
-				end
-			end
-			
-			# Generate an SSL context which delegates to {host_context} to multiplex based on hostname.
-			def ssl_context
-				@server_context ||= OpenSSL::SSL::SSLContext.new.tap do |context|
-					context.servername_cb = Proc.new do |socket, hostname|
-						self.host_context(socket, hostname)
-					end
-					
-					context.session_id_context = @session_id
-					
-					context.ssl_version = :TLSv1_2_server
-					
-					context.set_params(
-						ciphers: TLS::SERVER_CIPHERS,
-						verify_mode: OpenSSL::SSL::VERIFY_NONE,
-					)
-					
-					context.setup
-				end
-			end
-			
-			# The endpoint the server will bind to.
-			def endpoint
-				@command.endpoint.with(
-					ssl_context: self.ssl_context,
-					reuse_address: true,
-				)
-			end
-			
-			# Builds a map of host redirections.
-			def start
-				configuration = @command.configuration
-				
-				services = Services.new(configuration)
-				
-				@hosts = {}
-				
-				services.each do |service|
-					if service.is_a?(Service::Proxy)
-						Console.logger.info(self) {"Proxying #{service.authority} to #{service.endpoint}"}
-						@hosts[service.authority] = service
-						
-						# Pre-cache the ssl contexts:
-						# It seems some OpenSSL objects don't like event-driven I/O.
-						service.ssl_context
-					end
-				end
-				
-				super
-			end
-		end
-	end
-end

data/lib/falcon/controller/redirect.rb

@@ -1,59 +0,0 @@
-# frozen_string_literal: true
-
-# Released under the MIT License.
-# Copyright, 2020-2023, by Samuel Williams.
-
-require 'async/container/controller'
-
-require_relative 'serve'
-require_relative '../middleware/redirect'
-require_relative '../service/proxy'
-
-module Falcon
-	module Controller
-		# A controller for redirecting requests.
-		class Redirect < Serve
-			# Initialize the redirect controller.
-			# @parameter command [Command::Redirect] The user-specified command-line options.
-			def initialize(command, **options)
-				super(command, **options)
-				
-				@hosts = {}
-			end
-			
-			# Load the {Middleware::Redirect} application with the specified hosts.
-			def load_app
-				return Middleware::Redirect.new(Middleware::NotFound, @hosts, @command.redirect_endpoint)
-			end
-			
-			# The name of the controller which is used for the process title.
-			def name
-				"Falcon Redirect Server"
-			end
-			
-			# The endpoint the server will bind to.
-			def endpoint
-				@command.endpoint.with(
-					reuse_address: true,
-				)
-			end
-			
-			# Builds a map of host redirections.
-			def start
-				configuration = @command.configuration
-				
-				services = Services.new(configuration)
-				
-				@hosts = {}
-				
-				services.each do |service|
-					if service.is_a?(Service::Proxy)
-						@hosts[service.authority] = service
-					end
-				end
-				
-				super
-			end
-		end
-	end
-end

data/lib/falcon/controller/serve.rb

@@ -1,110 +0,0 @@
-# frozen_string_literal: true
-
-# Released under the MIT License.
-# Copyright, 2020-2023, by Samuel Williams.
-# Copyright, 2020, by Michael Adams.
-
-require_relative '../server'
-
-require 'async/container/controller'
-require 'async/io/trap'
-
-require 'async/io/shared_endpoint'
-
-module Falcon
-	module Controller
-		# A generic controller for serving an application.
-		# Uses {Server} for handling incoming requests.
-		class Serve < Async::Container::Controller
-			# Initialize the server controller.
-			# @parameter command [Command::Serve] The user-specified command-line options.
-			def initialize(command, **options)
-				@command = command
-				
-				@endpoint = nil
-				@bound_endpoint = nil
-				@debug_trap = Async::IO::Trap.new(:USR1)
-				
-				super(**options)
-			end
-			
-			# Create the controller as specified by the command.
-			# e.g. `Async::Container::Forked`.
-			def create_container
-				@command.container_class.new
-			end
-			
-			# The endpoint the server will bind to.
-			def endpoint
-				@command.endpoint
-			end
-			
-			# @returns [Protocol::HTTP::Middleware] an instance of the application to be served.
-			def load_app
-				@command.load_app
-			end
-			
-			# Prepare the bound endpoint for the server.
-			def start
-				@endpoint ||= self.endpoint
-				
-				@bound_endpoint = Async do
-					Async::IO::SharedEndpoint.bound(@endpoint)
-				end.wait
-				
-				Console.logger.info(self) { "Starting #{name} on #{@endpoint.to_url}" }
-				
-				@debug_trap.ignore!
-				
-				super
-			end
-			
-			# The name of the controller which is used for the process title.
-			def name
-				"Falcon Server"
-			end
-			
-			# Setup the container with the application instance.
-			# @parameter container [Async::Container::Generic]
-			def setup(container)
-				container.run(name: self.name, restart: true, **@command.container_options) do |instance|
-					Async do |task|
-						# Load one app instance per container:
-						app = self.load_app
-						
-						task.async do
-							if @debug_trap.install!
-								Console.logger.info(instance) do
-									"- Per-process status: kill -USR1 #{Process.pid}"
-								end
-							end
-							
-							@debug_trap.trap do
-								Console.logger.info(self) do |buffer|
-									task.reactor.print_hierarchy(buffer)
-								end
-							end
-						end
-						
-						server = Falcon::Server.new(app, @bound_endpoint, protocol: @endpoint.protocol, scheme: @endpoint.scheme)
-						
-						server.run
-						
-						instance.ready!
-						
-						task.children.each(&:wait)
-					end
-				end
-			end
-			
-			# Close the bound endpoint.
-			def stop(*)
-				@bound_endpoint&.close
-				
-				@debug_trap.default!
-				
-				super
-			end
-		end
-	end
-end

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