falcon 0.42.3 → 0.44.0

data/lib/rackup/handler/falcon.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2023, by Samuel Williams.
+
+require 'rackup/handler'
+
+require_relative '../../falcon'
+
+require 'kernel/sync'
+require 'async/io/host_endpoint'
+require 'async/io/notification'
+
+module Rackup
+	module Handler
+		# The falcon adaptor for the `rackup` executable.
+		class Falcon
+			# The default scheme.
+			SCHEME = "http"
+			
+			# Generate an endpoint for the given `rackup` options.
+			# @returns [Async::IO::Endpoint]
+			def self.endpoint_for(**options)
+				host = options[:Host] || 'localhost'
+				port = Integer(options[:Port] || 9292)
+				
+				return Async::IO::Endpoint.tcp(host, port)
+			end
+			
+			# Run the specified app using the given options:
+			# @parameter app [Object] The rack middleware.
+			def self.run(app, **options)
+				app = ::Protocol::Rack::Adapter.new(app)
+						
+				Sync do |task|
+					endpoint = endpoint_for(**options)
+					server = ::Falcon::Server.new(app, endpoint, protocol: Async::HTTP::Protocol::HTTP1, scheme: SCHEME)
+
+					server_task = task.async do
+						server.run.each(&:wait)
+					end
+
+					wrapper = self.new(server, task)
+					
+					yield wrapper if block_given?
+
+					server_task.wait
+				ensure
+					server_task.stop
+					wrapper.close
+				end
+			end
+
+			def initialize(server, task)
+				@server = server
+				@task = task
+
+				@notification = Async::IO::Notification.new
+
+				@waiter = @task.async(transient: true) do
+					@notification.wait
+
+					@task&.stop
+					@task = nil
+				end
+			end
+
+			def stop
+				@notification&.signal
+			end
+
+			def close
+				@notification&.close
+				@notification = nil
+
+				@waiter&.stop
+				@waiter = nil
+			end
+		end
+
+		register :falcon, Falcon
+	end
+end

data/license.md

@@ -0,0 +1,41 @@
+# MIT License
+
+Copyright, 2017-2024, by Samuel Williams.  
+Copyright, 2018, by Kent Gruber.  
+Copyright, 2018, by Janko Marohnić.  
+Copyright, 2018, by Tad Thorley.  
+Copyright, 2018, by Mitsutaka Mimura.  
+Copyright, 2018, by Kyle Tam.  
+Copyright, 2018, by Claudiu Garba.  
+Copyright, 2019, by Bryan Powell.  
+Copyright, 2019, by Sh Lin.  
+Copyright, 2019, by Sho Ito.  
+Copyright, 2019, by Colby Swandale.  
+Copyright, 2020, by Daniel Evans.  
+Copyright, 2020, by Mikel Kew.  
+Copyright, 2020, by Michael Adams.  
+Copyright, 2020, by Tasos Latsas.  
+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
+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.

data/readme.md

@@ -0,0 +1,60 @@
+# ![Falcon](logo.svg)
+
+Falcon is a multi-process, multi-fiber rack-compatible HTTP server built on top of [async](https://github.com/socketry/async), [async-io](https://github.com/socketry/async-io), [async-container](https://github.com/socketry/async-container) and [async-http](https://github.com/socketry/async-http). Each request is executed within a lightweight fiber and can block on up-stream requests without stalling the entire server process. Falcon supports HTTP/1 and HTTP/2 natively.
+
+[![Development Status](https://github.com/socketry/falcon/workflows/Test/badge.svg)](https://github.com/socketry/falcon/actions?workflow=Test)
+
+## Motivation
+
+Initially, when I developed [async](https://github.com/socketry/async), I saw an opportunity to implement [async-http](https://github.com/socketry/async-http): providing both client and server components. After experimenting with these ideas, I decided to build an actual web server for comparing and validating performance primarily out of interest. Falcon grew out of those experiments and permitted the ability to test existing real-world code on top of [async](https://github.com/socketry/async).
+
+Once I had something working, I saw an opportunity to simplify my development, testing and production environments, replacing production (Nginx+Passenger) and development (Puma) with Falcon. Not only does this simplify deployment, it helps minimize environment-specific bugs.
+
+My long term vision for Falcon is to make a web application platform which trivializes server deployment. Ideally, a web application can fully describe all its components: HTTP servers, databases, periodic jobs, background jobs, remote management, etc. Currently, it is not uncommon for all these facets to be handled independently in platform specific ways. This can make it difficult to set up new instances as well as make changes to underlying infrastructure. I hope Falcon can address some of these issues in a platform agnostic way.
+
+As web development is something I'm passionate about, having a server like Falcon is empowering.
+
+## Priority Business Support
+
+Falcon can be an important part of your business or project, both improving performance and saving money. As such, priority business support is available to make every project a success. The support agreement will give you:
+
+  - Direct support and assistance via Slack and email.
+  - Advance notification of bugs and security issues.
+  - Priority consideration of feature requests and bug reports.
+  - Better software by funding development and testing.
+
+Please visit [Socketry.io](https://socketry.io) to register and subscribe.
+
+## Usage
+
+Please see the [project documentation](https://socketry.github.io/falcon/) for more details.
+
+  - [Getting Started](https://socketry.github.io/falcon/guides/getting-started/index) - This guide explains how to use Falcon for Ruby web application development.
+
+  - [Rails Integration](https://socketry.github.io/falcon/guides/rails-integration/index) - This guide explains how to host Rails applications with Falcon.
+
+  - [Deployment](https://socketry.github.io/falcon/guides/deployment/index) - This guide explains how to use Falcon in production environments.
+
+  - [Extended Features](https://socketry.github.io/falcon/guides/extended-features/index) - This guide explains some of the extended features and functionality of Falcon.
+
+  - [Performance Tuning](https://socketry.github.io/falcon/guides/performance-tuning/index) - This guide explains the performance characteristics of Falcon.
+
+  - [How It Works](https://socketry.github.io/falcon/guides/how-it-works/index) - This guide gives an overview of how Falcon handles an incoming web request.
+
+## Contributing
+
+We welcome contributions to this project.
+
+1.  Fork it.
+2.  Create your feature branch (`git checkout -b my-new-feature`).
+3.  Commit your changes (`git commit -am 'Add some feature'`).
+4.  Push to the branch (`git push origin my-new-feature`).
+5.  Create new Pull Request.
+
+### Developer Certificate of Origin
+
+This project uses the [Developer Certificate of Origin](https://developercertificate.org/). All contributors to this project must agree to this document to have their contributions accepted.
+
+### Contributor Covenant
+
+This project is governed by the [Contributor Covenant](https://www.contributor-covenant.org/). All contributors and participants agree to abide by its terms.

metadata

@@ -1,27 +1,30 @@
 --- !ruby/object:Gem::Specification
 name: falcon
 version: !ruby/object:Gem::Version
-  version: 0.42.3
+  version: 0.44.0
 platform: ruby
 authors:
 - Samuel Williams
 - Janko Marohnić
-- dependabot[bot]
 - Bryan Powell
+- Claudiu Garba
+- Kyle Tam
+- Mitsutaka Mimura
 - Sho Ito
-- claudiu
-- takkanm
-- tamkylet
+- Trevor Turk
 - Colby Swandale
 - Daniel Evans
 - Kent Gruber
 - Michael Adams
 - Mikel Kew
+- Nick Janetakis
 - Olle Jonsson
+- Peter Schrammel
+- Santiago Bartesaghi
 - Sh Lin
 - Tad Thorley
 - Tasos Latsas
-- deepj
+- dependabot[bot]
 autorequire:
 bindir: bin
 cert_chain:
@@ -54,7 +57,7 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2022-08-28 00:00:00.000000000 Z
+date: 2024-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async
@@ -76,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
@@ -127,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
@@ -224,90 +227,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.1'
-- !ruby/object:Gem::Dependency
-  name: async-process
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.1'
-- !ruby/object:Gem::Dependency
-  name: async-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.7'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.7'
-- !ruby/object:Gem::Dependency
-  name: async-websocket
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.19.2
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.19.2
-- !ruby/object:Gem::Dependency
-  name: bake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: covered
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.6'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.6'
 description:
 email:
 executables:
@@ -319,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
@@ -331,37 +250,38 @@ 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
+- lib/rackup/handler/falcon.rb
+- license.md
+- readme.md
 homepage: https://github.com/socketry/falcon
 licenses:
 - MIT
-metadata: {}
+metadata:
+  documentation_uri: https://socketry.github.io/falcon/
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -370,14 +290,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+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,72 +0,0 @@
-# frozen_string_literal: true
-
-# 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_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,126 +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 '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