falcon 0.42.3 → 0.44.0

data/lib/falcon/service/application.rb

@@ -1,115 +0,0 @@
-# frozen_string_literal: true
-
-# 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 '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,78 +0,0 @@
-# frozen_string_literal: true
-
-# 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
-		# 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,66 +0,0 @@
-# frozen_string_literal: true
-
-# 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 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,99 +0,0 @@
-# frozen_string_literal: true
-
-# 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 '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