# frozen_string_literal: true
# Copyright, 2017, 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 '../server'
require_relative '../endpoint'
require_relative '../controller/serve'
require 'async/container'
require 'async/io/trap'
require 'async/io/host_endpoint'
require 'async/io/shared_endpoint'
require 'async/io/ssl_endpoint'
require 'samovar'
require 'rack/builder'
require 'rack/server'
require 'bundler'
module Falcon
module Command
# Implements the `falcon serve` command. Designed for *development*.
#
# Manages a {Controller::Serve} instance which is responsible for running applications in a development environment.
class Serve < Samovar::Command
self.description = "Run an HTTP server for development purposes."
# The command line options.
# @attribute [Samovar::Options]
options do
option '-b/--bind <address>', "Bind to the given hostname/address.", default: "https://localhost:9292"
option '-p/--port <number>', "Override the specified port.", type: Integer
option '-h/--hostname <hostname>', "Specify the hostname which would be used for certificates, etc."
option '-t/--timeout <duration>', "Specify the maximum time to wait for non-blocking operations.", type: Float, default: nil
option '-c/--config <path>', "Rackup configuration file to load.", default: 'config.ru'
option '--preload <path>', "Preload the specified path before creating containers."
option '--cache', "Enable the response cache."
option '--forked | --threaded | --hybrid', "Select a specific parallelism model.", key: :container, default: :forked
option '-n/--count <count>', "Number of instances to start.", default: Async::Container.processor_count, type: Integer
option '--forks <count>', "Number of forks (hybrid only).", type: Integer
option '--threads <count>', "Number of threads (hybrid only).", type: Integer
end
# The container class to use.
def container_class
case @options[:container]
when :threaded
return Async::Container::Threaded
when :forked
return Async::Container::Forked
when :hybrid
return Async::Container::Hybrid
end
end
# Whether verbose logging is enabled.
# @returns [Boolean]
def verbose?
@parent&.verbose?
end
# Whether to enable the application HTTP cache.
# @returns [Boolean]
def cache?
@options[:cache]
end
# Load the rack application from the specified configuration path.
# @returns [Protocol::HTTP::Middleware]
def load_app
rack_app, _ = Rack::Builder.parse_file(@options[:config])
return Server.middleware(rack_app, verbose: self.verbose?, cache: self.cache?)
end
# Options for the container.
# See {Controller::Serve#setup}.
def container_options
@options.slice(:count, :forks, :threads)
end
# Options for the {endpoint}.
def endpoint_options
@options.slice(:hostname, :port, :reuse_port, :timeout)
end
# The endpoint to bind to.
def endpoint
Endpoint.parse(@options[:bind], **endpoint_options)
end
# The endpoint suitable for a client to connect.
def client_endpoint
Async::HTTP::Endpoint.parse(@options[:bind], **endpoint_options)
end
# Create a new client suitable for accessing the application.
def client
Async::HTTP::Client.new(client_endpoint)
end
# Prepare a new controller for the command.
def controller
Controller::Serve.new(self)
end
# Prepare the environment and run the controller.
def call
Console.logger.info(self) do |buffer|
buffer.puts "Falcon v#{VERSION} taking flight! Using #{self.container_class} #{self.container_options}."
buffer.puts "- Binding to: #{self.endpoint}"
buffer.puts "- To terminate: Ctrl-C or kill #{Process.pid}"
buffer.puts "- To reload configuration: kill -HUP #{Process.pid}"
end
if path = @options[:preload]
full_path = File.expand_path(path)
load(full_path)
end
begin
Bundler.require(:preload)
rescue Bundler::GemfileNotFound
# Ignore.
end
if GC.respond_to?(:compact)
GC.compact
end
self.controller.run
end
end
end
end