rackup 1.0.0 → 2.2.0

data/lib/rackup/server.rb

@@ -0,0 +1,462 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2022-2023, by Samuel Williams.
+
+require 'optparse'
+require 'fileutils'
+
+require 'rack/builder'
+require 'rack/common_logger'
+require 'rack/content_length'
+require 'rack/show_exceptions'
+require 'rack/lint'
+require 'rack/tempfile_reaper'
+
+require 'rack/version'
+
+require_relative 'version'
+require_relative 'handler'
+
+module Rackup
+  class Server
+    class Options
+      def parse!(args)
+        options = {}
+        opt_parser = OptionParser.new("", 24, '  ') do |opts|
+          opts.banner = "Usage: rackup [ruby options] [rack options] [rackup config]"
+
+          opts.separator ""
+          opts.separator "Ruby options:"
+
+          lineno = 1
+          opts.on("-e", "--eval LINE", "evaluate a LINE of code") { |line|
+            eval line, TOPLEVEL_BINDING, "-e", lineno
+            lineno += 1
+          }
+
+          opts.on("-d", "--debug", "set debugging flags (set $DEBUG to true)") {
+            options[:debug] = true
+          }
+          opts.on("-w", "--warn", "turn warnings on for your script") {
+            options[:warn] = true
+          }
+          opts.on("-q", "--quiet", "turn off logging") {
+            options[:quiet] = true
+          }
+
+          opts.on("-I", "--include PATH",
+                  "specify $LOAD_PATH (may be used more than once)") { |path|
+            (options[:include] ||= []).concat(path.split(":"))
+          }
+
+          opts.on("-r", "--require LIBRARY",
+                  "require the library, before executing your script") { |library|
+            (options[:require] ||= []) << library
+          }
+
+          opts.separator ""
+          opts.separator "Rack options:"
+          opts.on("-b", "--builder BUILDER_LINE", "evaluate a BUILDER_LINE of code as a builder script") { |line|
+            options[:builder] = line
+          }
+
+          opts.on("-s", "--server SERVER", "serve using SERVER (thin/puma/webrick)") { |s|
+            options[:server] = s
+          }
+
+          opts.on("-o", "--host HOST", "listen on HOST (default: localhost)") { |host|
+            options[:Host] = host
+          }
+
+          opts.on("-p", "--port PORT", "use PORT (default: 9292)") { |port|
+            options[:Port] = port
+          }
+
+          opts.on("-O", "--option NAME[=VALUE]", "pass VALUE to the server as option NAME. If no VALUE, sets it to true. Run '#{$0} -s SERVER -h' to get a list of options for SERVER") { |name|
+            name, value = name.split('=', 2)
+            value = true if value.nil?
+            options[name.to_sym] = value
+          }
+
+          opts.on("-E", "--env ENVIRONMENT", "use ENVIRONMENT for defaults (default: development)") { |e|
+            options[:environment] = e
+          }
+
+          opts.on("-D", "--daemonize", "run daemonized in the background") { |d|
+            options[:daemonize] ||= true
+          }
+
+          opts.on("--daemonize-noclose", "run daemonized in the background without closing stdout/stderr") {
+            options[:daemonize] = :noclose
+          }
+
+          opts.on("-P", "--pid FILE", "file to store PID") { |f|
+            options[:pid] = ::File.expand_path(f)
+          }
+
+          opts.separator ""
+          opts.separator "Profiling options:"
+
+          opts.on("--heap HEAPFILE", "Build the application, then dump the heap to HEAPFILE") do |e|
+            options[:heapfile] = e
+          end
+
+          opts.on("--profile PROFILE", "Dump CPU or Memory profile to PROFILE (defaults to a tempfile)") do |e|
+            options[:profile_file] = e
+          end
+
+          opts.on("--profile-mode MODE", "Profile mode (cpu|wall|object)") do |e|
+            unless %w[cpu wall object].include?(e)
+              raise OptionParser::InvalidOption, "unknown profile mode: #{e}"
+            end
+            options[:profile_mode] = e.to_sym
+          end
+
+          opts.separator ""
+          opts.separator "Common options:"
+
+          opts.on_tail("-h", "-?", "--help", "Show this message") do
+            puts opts
+            puts handler_opts(options)
+
+            exit
+          end
+
+          opts.on_tail("--version", "Show version") do
+            puts "Rack #{Rack::RELEASE}"
+            exit
+          end
+        end
+
+        begin
+          opt_parser.parse! args
+        rescue OptionParser::InvalidOption => e
+          warn e.message
+          abort opt_parser.to_s
+        end
+
+        options[:config] = args.last if args.last && !args.last.empty?
+        options
+      end
+
+      def handler_opts(options)
+        info = []
+        server = Rackup::Handler.get(options[:server]) || Rackup::Handler.default
+        if server && server.respond_to?(:valid_options)
+          info << ""
+          info << "Server-specific options for #{server.name}:"
+
+          has_options = false
+          server.valid_options.each do |name, description|
+            next if /^(Host|Port)[^a-zA-Z]/.match?(name.to_s) # ignore handler's host and port options, we do our own.
+            info << sprintf("  -O %-21s %s", name, description)
+            has_options = true
+          end
+          return "" if !has_options
+        end
+        info.join("\n")
+      rescue NameError, LoadError
+        return "Warning: Could not find handler specified (#{options[:server] || 'default'}) to determine handler-specific options"
+      end
+    end
+
+    # Start a new rack server (like running rackup). This will parse ARGV and
+    # provide standard ARGV rackup options, defaulting to load 'config.ru'.
+    #
+    # Providing an options hash will prevent ARGV parsing and will not include
+    # any default options.
+    #
+    # This method can be used to very easily launch a CGI application, for
+    # example:
+    #
+    #  Rack::Server.start(
+    #    :app => lambda do |e|
+    #      [200, {'content-type' => 'text/html'}, ['hello world']]
+    #    end,
+    #    :server => 'cgi'
+    #  )
+    #
+    # Further options available here are documented on Rack::Server#initialize
+    def self.start(options = nil)
+      new(options).start
+    end
+
+    attr_writer :options
+
+    # Options may include:
+    # * :app
+    #     a rack application to run (overrides :config and :builder)
+    # * :builder
+    #     a string to evaluate a Rack::Builder from
+    # * :config
+    #     a rackup configuration file path to load (.ru)
+    # * :environment
+    #     this selects the middleware that will be wrapped around
+    #     your application. Default options available are:
+    #       - development: CommonLogger, ShowExceptions, and Lint
+    #       - deployment: CommonLogger
+    #       - none: no extra middleware
+    #     note: when the server is a cgi server, CommonLogger is not included.
+    # * :server
+    #     choose a specific Rackup::Handler, e.g. cgi, fcgi, webrick
+    # * :daemonize
+    #     if truthy, the server will daemonize itself (fork, detach, etc)
+    #     if :noclose, the server will not close STDOUT/STDERR
+    # * :pid
+    #     path to write a pid file after daemonize
+    # * :Host
+    #     the host address to bind to (used by supporting Rackup::Handler)
+    # * :Port
+    #     the port to bind to (used by supporting Rackup::Handler)
+    # * :AccessLog
+    #     webrick access log options (or supporting Rackup::Handler)
+    # * :debug
+    #     turn on debug output ($DEBUG = true)
+    # * :warn
+    #     turn on warnings ($-w = true)
+    # * :include
+    #     add given paths to $LOAD_PATH
+    # * :require
+    #     require the given libraries
+    #
+    # Additional options for profiling app initialization include:
+    # * :heapfile
+    #     location for ObjectSpace.dump_all to write the output to
+    # * :profile_file
+    #     location for CPU/Memory (StackProf) profile output (defaults to a tempfile)
+    # * :profile_mode
+    #     StackProf profile mode (cpu|wall|object)
+    def initialize(options = nil)
+      @ignore_options = []
+
+      if options
+        @use_default_options = false
+        @options = options
+        @app = options[:app] if options[:app]
+      else
+        @use_default_options = true
+        @options = parse_options(ARGV)
+      end
+    end
+
+    def options
+      merged_options = @use_default_options ? default_options.merge(@options) : @options
+      merged_options.reject { |k, v| @ignore_options.include?(k) }
+    end
+
+    def default_options
+      environment  = ENV['RACK_ENV'] || 'development'
+      default_host = environment == 'development' ? 'localhost' : '0.0.0.0'
+
+      {
+        environment: environment,
+        pid: nil,
+        Port: 9292,
+        Host: default_host,
+        AccessLog: [],
+        config: "config.ru"
+      }
+    end
+
+    def app
+      @app ||= options[:builder] ? build_app_from_string : build_app_and_options_from_config
+    end
+
+    class << self
+      def logging_middleware
+        lambda { |server|
+          /CGI/.match?(server.server.name) || server.options[:quiet] ? nil : [Rack::CommonLogger, $stderr]
+        }
+      end
+
+      def default_middleware_by_environment
+        m = Hash.new {|h, k| h[k] = []}
+        m["deployment"] = [
+          [Rack::ContentLength],
+          logging_middleware,
+          [Rack::TempfileReaper]
+        ]
+        m["development"] = [
+          [Rack::ContentLength],
+          logging_middleware,
+          [Rack::ShowExceptions],
+          [Rack::Lint],
+          [Rack::TempfileReaper]
+        ]
+
+        m
+      end
+
+      def middleware
+        default_middleware_by_environment
+      end
+    end
+
+    def middleware
+      self.class.middleware
+    end
+
+    def start(&block)
+      if options[:warn]
+        $-w = true
+      end
+
+      if includes = options[:include]
+        $LOAD_PATH.unshift(*includes)
+      end
+
+      Array(options[:require]).each do |library|
+        require library
+      end
+
+      if options[:debug]
+        $DEBUG = true
+        require 'pp'
+        p options[:server]
+        pp wrapped_app
+        pp app
+      end
+
+      check_pid! if options[:pid]
+
+      # Touch the wrapped app, so that the config.ru is loaded before
+      # daemonization (i.e. before chdir, etc).
+      handle_profiling(options[:heapfile], options[:profile_mode], options[:profile_file]) do
+        wrapped_app
+      end
+
+      daemonize_app if options[:daemonize]
+
+      write_pid if options[:pid]
+
+      trap(:INT) do
+        if server.respond_to?(:shutdown)
+          server.shutdown
+        else
+          exit
+        end
+      end
+
+      server.run(wrapped_app, **options, &block)
+    end
+
+    def server
+      @_server ||= Handler.get(options[:server]) || Handler.default
+    end
+
+    private
+      def build_app_and_options_from_config
+        if !::File.exist? options[:config]
+          abort "configuration #{options[:config]} not found"
+        end
+
+        return Rack::Builder.parse_file(self.options[:config])
+      end
+
+      def handle_profiling(heapfile, profile_mode, filename)
+        if heapfile
+          require "objspace"
+          ObjectSpace.trace_object_allocations_start
+          yield
+          GC.start
+          ::File.open(heapfile, "w") { |f| ObjectSpace.dump_all(output: f) }
+          exit
+        end
+
+        if profile_mode
+          require "stackprof"
+          require "tempfile"
+
+          make_profile_name(filename) do |filename|
+            ::File.open(filename, "w") do |f|
+              StackProf.run(mode: profile_mode, out: f) do
+                yield
+              end
+              puts "Profile written to: #{filename}"
+            end
+          end
+          exit
+        end
+
+        yield
+      end
+
+      def make_profile_name(filename)
+        if filename
+          yield filename
+        else
+          ::Dir::Tmpname.create("profile.dump") do |tmpname, _, _|
+            yield tmpname
+          end
+        end
+      end
+
+      def build_app_from_string
+        Rack::Builder.new_from_string(self.options[:builder])
+      end
+
+      def parse_options(args)
+        # Don't evaluate CGI ISINDEX parameters.
+        args.clear if ENV.include?(Rack::REQUEST_METHOD)
+
+        @options = opt_parser.parse!(args)
+        @options[:config] = ::File.expand_path(options[:config])
+        ENV["RACK_ENV"] = options[:environment]
+        @options
+      end
+
+      def opt_parser
+        Options.new
+      end
+
+      def build_app(app)
+        middleware[options[:environment]].reverse_each do |middleware|
+          middleware = middleware.call(self) if middleware.respond_to?(:call)
+          next unless middleware
+          klass, *args = middleware
+          app = klass.new(app, *args)
+        end
+        app
+      end
+
+      def wrapped_app
+        @wrapped_app ||= build_app app
+      end
+
+      def daemonize_app
+        # Cannot be covered as it forks
+        # :nocov:
+        Process.daemon(true, options[:daemonize] == :noclose)
+        # :nocov:
+      end
+
+      def write_pid
+        ::File.open(options[:pid], ::File::CREAT | ::File::EXCL | ::File::WRONLY ){ |f| f.write("#{Process.pid}") }
+        at_exit { ::FileUtils.rm_f(options[:pid]) }
+      rescue Errno::EEXIST
+        check_pid!
+        retry
+      end
+
+      def check_pid!
+        return unless ::File.exist?(options[:pid])
+
+        pid = ::File.read(options[:pid]).to_i
+        raise Errno::ESRCH if pid == 0
+
+        Process.kill(0, pid)
+        exit_with_pid(pid)
+      rescue Errno::ESRCH
+        ::File.delete(options[:pid])
+      rescue Errno::EPERM
+        exit_with_pid(pid)
+      end
+
+      def exit_with_pid(pid)
+        $stderr.puts "A server is already running (pid: #{pid}, file: #{options[:pid]})."
+        exit(1)
+      end
+  end
+
+end

data/lib/rackup/stream.rb

@@ -0,0 +1,199 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2023-2024, by Samuel Williams.
+
+module Rackup
+  # The input stream is an IO-like object which contains the raw HTTP POST data. When applicable, its external encoding must be “ASCII-8BIT” and it must be opened in binary mode, for Ruby 1.9 compatibility. The input stream must respond to gets, each, read and rewind.
+  class Stream
+    def initialize(input = nil, output = Buffered.new)
+      @input = input
+      @output = output
+
+      raise ArgumentError, "Non-writable output!" unless output.respond_to?(:write)
+
+      # Will hold remaining data in `#read`.
+      @buffer = nil
+      @closed = false
+    end
+
+    attr :input
+    attr :output
+
+    # This provides a read-only interface for data, which is surprisingly tricky to implement correctly.
+    module Reader
+      # rack.hijack_io must respond to:
+      # read, write, read_nonblock, write_nonblock, flush, close, close_read, close_write, closed?
+
+      # read behaves like IO#read. Its signature is read([length, [buffer]]). If given, length must be a non-negative Integer (>= 0) or nil, and buffer must be a String and may not be nil. If length is given and not nil, then this method reads at most length bytes from the input stream. If length is not given or nil, then this method reads all data until EOF. When EOF is reached, this method returns nil if length is given and not nil, or “” if length is not given or is nil. If buffer is given, then the read data will be placed into buffer instead of a newly created String object.
+      # @param length [Integer] the amount of data to read
+      # @param buffer [String] the buffer which will receive the data
+      # @return a buffer containing the data
+      def read(length = nil, buffer = nil)
+        return '' if length == 0
+
+        buffer ||= String.new.force_encoding(Encoding::BINARY)
+
+        # Take any previously buffered data and replace it into the given buffer.
+        if @buffer
+          buffer.replace(@buffer)
+          @buffer = nil
+        else
+          buffer.clear
+        end
+
+        if length
+          while buffer.bytesize < length and chunk = read_next
+            buffer << chunk
+          end
+
+          # This ensures the subsequent `slice!` works correctly.
+          buffer.force_encoding(Encoding::BINARY)
+
+          # This will be at least one copy:
+          @buffer = buffer.byteslice(length, buffer.bytesize)
+
+          # This should be zero-copy:
+          buffer.slice!(length, buffer.bytesize)
+
+          if buffer.empty?
+            return nil
+          else
+            return buffer
+          end
+        else
+          while chunk = read_next
+            buffer << chunk
+          end
+
+          return buffer
+        end
+      end
+
+      # Read at most `length` bytes from the stream. Will avoid reading from the underlying stream if possible.
+      def read_partial(length = nil)
+        if @buffer
+          buffer = @buffer
+          @buffer = nil
+        else
+          buffer = read_next
+        end
+
+        if buffer and length
+          if buffer.bytesize > length
+            # This ensures the subsequent `slice!` works correctly.
+            buffer.force_encoding(Encoding::BINARY)
+
+            @buffer = buffer.byteslice(length, buffer.bytesize)
+            buffer.slice!(length, buffer.bytesize)
+          end
+        end
+
+        return buffer
+      end
+
+      def gets
+        read_partial
+      end
+
+      def each
+        while chunk = read_partial
+          yield chunk
+        end
+      end
+
+      def read_nonblock(length, buffer = nil)
+        @buffer ||= read_next
+        chunk = nil
+
+        unless @buffer
+          buffer&.clear
+          return
+        end
+
+        if @buffer.bytesize > length
+          chunk = @buffer.byteslice(0, length)
+          @buffer = @buffer.byteslice(length, @buffer.bytesize)
+        else
+          chunk = @buffer
+          @buffer = nil
+        end
+
+        if buffer
+          buffer.replace(chunk)
+        else
+          buffer = chunk
+        end
+
+        return buffer
+      end
+    end
+
+    include Reader
+
+    def write(buffer)
+      if @output
+        @output.write(buffer)
+        return buffer.bytesize
+      else
+        raise IOError, "Stream is not writable, output has been closed!"
+      end
+    end
+
+    def write_nonblock(buffer)
+      write(buffer)
+    end
+
+    def <<(buffer)
+      write(buffer)
+    end
+
+    def flush
+    end
+
+    def close_read
+      @input&.close
+      @input = nil
+    end
+
+    # close must never be called on the input stream. huh?
+    def close_write
+      if @output.respond_to?(:close)
+        @output&.close
+      end
+
+      @output = nil
+    end
+
+    # Close the input and output bodies.
+    def close(error = nil)
+      self.close_read
+      self.close_write
+
+      return nil
+    ensure
+      @closed = true
+    end
+
+    # Whether the stream has been closed.
+    def closed?
+      @closed
+    end
+
+    # Whether there are any output chunks remaining?
+    def empty?
+      @output.empty?
+    end
+
+    private
+
+    def read_next
+      if @input
+        return @input.read
+      else
+        @input = nil
+        raise IOError, "Stream is not readable, input has been closed!"
+      end
+    end
+  end
+end

data/lib/rackup/version.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2022, by Samuel Williams.
+# Copyright, 2022-2023, by Samuel Williams.
 
 module Rackup
-  VERSION = "1.0.0"
+  VERSION = "2.2.0"
 end

data/lib/rackup.rb

@@ -1,11 +1,8 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2022, by Samuel Williams.
+# Copyright, 2022-2024, by Samuel Williams.
 
 require_relative 'rackup/handler'
 require_relative 'rackup/server'
 require_relative 'rackup/version'
-
-require_relative 'rackup/handler/webrick'
-require_relative 'rackup/handler/cgi'