spider-gazelle 2.0.4 → 3.0.0

data/lib/spider-gazelle/gazelle/request.rb

@@ -1,22 +1,24 @@
+# frozen_string_literal: true
+
 require 'stringio'
 require 'rack'            # Ruby webserver abstraction
 
 module SpiderGazelle
     class Request < ::Libuv::Q::DeferredPromise
-        RACK_VERSION = 'rack.version'.freeze
-        RACK_ERRORS = 'rack.errors'.freeze
-        RACK_MULTITHREAD = "rack.multithread".freeze
-        RACK_MULTIPROCESS = "rack.multiprocess".freeze
-        RACK_RUN_ONCE = "rack.run_once".freeze
-        SCRIPT_NAME = "SCRIPT_NAME".freeze
-        EMPTY = ''.freeze
-        SERVER_PROTOCOL = "SERVER_PROTOCOL".freeze
-        HTTP_11 = "HTTP/1.1".freeze
-        SERVER_SOFTWARE = "SERVER_SOFTWARE".freeze
-        GATEWAY_INTERFACE = "GATEWAY_INTERFACE".freeze
-        CGI_VER = "CGI/1.2".freeze
-        SERVER = "SpiderGazelle".freeze
-        LOCALHOST = 'localhost'.freeze
+        RACK_VERSION = 'rack.version'
+        RACK_ERRORS = 'rack.errors'
+        RACK_MULTITHREAD = "rack.multithread"
+        RACK_MULTIPROCESS = "rack.multiprocess"
+        RACK_RUN_ONCE = "rack.run_once"
+        SCRIPT_NAME = "SCRIPT_NAME"
+        EMPTY = ''
+        SERVER_PROTOCOL = "SERVER_PROTOCOL"
+        HTTP_11 = "HTTP/1.1"
+        SERVER_SOFTWARE = "SERVER_SOFTWARE"
+        GATEWAY_INTERFACE = "GATEWAY_INTERFACE"
+        CGI_VER = "CGI/1.2"
+        SERVER = "SpiderGazelle"
+        LOCALHOST = 'localhost'
 
 
         # TODO:: Add HTTP headers to the env and capitalise them and prefix them with HTTP_
@@ -28,7 +30,7 @@ module SpiderGazelle
             RACK_MULTIPROCESS => true,        # will the app be simultaneously be invoked in a separate process?
             RACK_RUN_ONCE => false,            # this isn't CGI so will always be false
 
-            SCRIPT_NAME => ENV['SCRIPT_NAME'.freeze] || EMPTY,   #  The virtual path of the app base (empty if root)
+            SCRIPT_NAME => ENV['SCRIPT_NAME'] || EMPTY,   #  The virtual path of the app base (empty if root)
             SERVER_PROTOCOL => HTTP_11,
 
             GATEWAY_INTERFACE => CGI_VER,
@@ -39,17 +41,18 @@ module SpiderGazelle
         attr_reader :hijacked, :defer, :is_async
 
 
-        SERVER_PORT = "SERVER_PORT".freeze
-        REMOTE_ADDR = "REMOTE_ADDR".freeze
-        RACK_URL_SCHEME = "rack.url_scheme".freeze
+        SERVER_PORT = "SERVER_PORT"
+        REMOTE_ADDR = "REMOTE_ADDR"
+        RACK_URL_SCHEME = "rack.url_scheme"
 
-        def initialize(thread, app, port, remote_ip, scheme)
+        def initialize(thread, app, port, remote_ip, scheme, socket)
             super(thread, thread.defer)
 
+            @socket = socket
             @app = app
-            @body = ''
-            @header = ''
-            @url = ''
+            @body = String.new
+            @header = String.new
+            @url = String.new
             @env = PROTO_ENV.dup
             @env[SERVER_PORT] = port
             @env[REMOTE_ADDR] = remote_ip
@@ -57,41 +60,41 @@ module SpiderGazelle
         end
 
 
-        CONTENT_LENGTH = "CONTENT_LENGTH".freeze
-        HTTP_CONTENT_LENGTH = "HTTP_CONTENT_LENGTH".freeze
-        CONTENT_TYPE = "CONTENT_TYPE".freeze
-        HTTP_CONTENT_TYPE = "HTTP_CONTENT_TYPE".freeze
-        DEFAULT_TYPE = "text/plain".freeze
-        REQUEST_URI= "REQUEST_URI".freeze
-        ASCII_8BIT = "ASCII-8BIT".freeze
-        RACK_INPUT = "rack.input".freeze
-        PATH_INFO = "PATH_INFO".freeze
-        REQUEST_PATH = "REQUEST_PATH".freeze
-        QUERY_STRING = "QUERY_STRING".freeze
-        HTTP_HOST = "HTTP_HOST".freeze
-        COLON = ":".freeze
-        SERVER_NAME = "SERVER_NAME".freeze
+        CONTENT_LENGTH = "CONTENT_LENGTH"
+        HTTP_CONTENT_LENGTH = "HTTP_CONTENT_LENGTH"
+        CONTENT_TYPE = "CONTENT_TYPE"
+        HTTP_CONTENT_TYPE = "HTTP_CONTENT_TYPE"
+        DEFAULT_TYPE = "text/plain"
+        REQUEST_URI= "REQUEST_URI"
+        ASCII_8BIT = "ASCII-8BIT"
+        RACK_INPUT = "rack.input"
+        PATH_INFO = "PATH_INFO"
+        REQUEST_PATH = "REQUEST_PATH"
+        QUERY_STRING = "QUERY_STRING"
+        HTTP_HOST = "HTTP_HOST"
+        COLON = ":"
+        SERVER_NAME = "SERVER_NAME"
         # Hijacking IO is supported
-        HIJACK_P = "rack.hijack?".freeze
+        HIJACK_P = "rack.hijack?"
         # Callback for indicating that this socket will be hijacked
-        HIJACK = "rack.hijack".freeze
+        HIJACK = "rack.hijack"
         # The object for performing IO on after hijack is called
-        HIJACK_IO = "rack.hijack_io".freeze
-        QUESTION_MARK = "?".freeze
+        HIJACK_IO = "rack.hijack_io"
+        QUESTION_MARK = "?"
         
-        HTTP_UPGRADE = 'HTTP_UPGRADE'.freeze
-        USE_HTTP2 = 'h2c'.freeze
+        HTTP_UPGRADE = 'HTTP_UPGRADE'
+        USE_HTTP2 = 'h2c'
 
 
 
 
         def execute!
-            @env[CONTENT_LENGTH] = @env.delete(HTTP_CONTENT_LENGTH) || @body.length
+            @env[CONTENT_LENGTH] = @env.delete(HTTP_CONTENT_LENGTH) || @body.bytesize.to_s
             @env[CONTENT_TYPE] = @env.delete(HTTP_CONTENT_TYPE) || DEFAULT_TYPE
             @env[REQUEST_URI] = @url.freeze
 
             # For Rack::Lint on 1.9, ensure that the encoding is always for spec
-            @body.force_encoding(ASCII_8BIT) if @body.respond_to?(:force_encoding)
+            @body.force_encoding(ASCII_8BIT)
             @env[RACK_INPUT] = StringIO.new @body
 
             # Break the request into its components
@@ -111,7 +114,7 @@ module SpiderGazelle
             if host = @env[HTTP_HOST]
                 if colon = host.index(COLON)
                     @env[SERVER_NAME] = host[0, colon]
-                    @env[SERVER_PORT] = host[colon + 1, host.bytesize].to_i
+                    @env[SERVER_PORT] = host[colon + 1, host.bytesize]
                 else
                     @env[SERVER_NAME] = host
                 end
@@ -119,18 +122,16 @@ module SpiderGazelle
                 @env[SERVER_NAME] = LOCALHOST
             end
 
-            # Provide hijack options if this is an upgrade request
-            if @upgrade == true
-                if @env[HTTP_UPGRADE] == USE_HTTP2
-                    # TODO:: implement the upgrade process here
-                else
-                    @env[HIJACK_P] = true
-                    @env[HIJACK] = method :hijack
-                end
+            if @upgrade == true && @env[HTTP_UPGRADE] == USE_HTTP2
+                # TODO:: implement the upgrade process here
             end
 
+            # Provide hijack options
+            @env[HIJACK_P] = true
+            @env[HIJACK] = proc { @env[HIJACK_IO] = @socket }
+
             # Execute the request
-            # NOTE:: Catch was overloaded by Promise so this does the 
+            # NOTE:: Catch was overloaded by Promise so this does the trick now
             resp = ruby_catch(:async) { @app.call @env }
             if resp.nil? || resp[0] == -1
                 @is_async = true
@@ -143,13 +144,5 @@ module SpiderGazelle
             end
             resp
         end
-
-        protected
-
-        def hijack
-            @hijacked = @loop.defer
-            @env.delete HIJACK # don't want to hold a reference to this request object
-            @env[HIJACK_IO] = @hijacked.promise
-        end
     end
 end

data/lib/spider-gazelle/logger.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'libuv'
 
 module SpiderGazelle
@@ -19,7 +21,7 @@ module SpiderGazelle
 
 
         def initialize
-            @thread = ::Libuv::Loop.default
+            @thread = ::Libuv::Reactor.default
             @level = DEFAULT_LEVEL
             @write = method(:server_write)
         end
@@ -85,17 +87,12 @@ module SpiderGazelle
             end
         end
 
-        def print_error(e, msg = '', trace = nil)
-            msg << ":\n" unless msg.empty?
-            msg << "#{e.message}\n"
-            backtrace = e.backtrace if e.respond_to?(:backtrace)
-            if backtrace
-                msg << "#{backtrace.join("\n")}\n"
-            elsif trace.nil?
-                trace = caller
-            end
-            msg << "Caller backtrace:\n#{trace.join("\n")}\n" if trace
-            error(msg)
+        def print_error(e, msg = nil, trace = nil)
+            message = String.new(msg || e.message)
+            message << "\n#{e.message}" if msg
+            message << "\n#{e.backtrace.join("\n")}" if e.respond_to?(:backtrace) && e.backtrace
+            message << "\nCaller backtrace:\n#{trace.join("\n")}" if trace
+            error(message)
         end
 
         # NOTE:: should only be called on reactor thread

data/lib/spider-gazelle/options.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'set'
 require 'optparse'
 require 'spider-gazelle/logger'
@@ -10,10 +12,9 @@ module SpiderGazelle
             port: 3000,
             verbose: false,
             tls: false,
-            backlog: 5000,
+            backlog: 4096,
             rackup: "#{Dir.pwd}/config.ru",
             mode: :thread,
-            app_mode: :thread_pool,
             isolate: true
         }.freeze
 
@@ -59,12 +60,12 @@ module SpiderGazelle
                     options[:rackup] = arg
                 end
 
-                opts.on "-m", "--mode MODE", MODES, "Either process, thread or no_ipc (default: process)" do |arg|
-                    options[:mode] = arg
+                opts.on "-rl", "--rack-lint", "enable rack lint on all requests" do
+                    options[:lint] = true
                 end
 
-                opts.on "-a", "--app-mode MODE", APP_MODE, "How should requests be processed (default: thread_pool)" do |arg|
-                    options[:host] = arg
+                opts.on "-m", "--mode MODE", MODES, "Either process, thread or no_ipc (default: thread)" do |arg|
+                    options[:mode] = arg
                 end
 
                 opts.on "-b", "--backlog BACKLOG", Integer, "Number of pending connections allowed (default: 5000)" do |arg|
@@ -175,7 +176,7 @@ module SpiderGazelle
 
             # Ensure there is at least one component
             # (This will occur when no options are provided)
-            components << '' if components.empty?
+            components << String.new if components.empty?
 
             # Parse the commandline options
             options = []

data/lib/spider-gazelle/reactor.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'libuv'
 require 'spider-gazelle/logger'
 
@@ -9,7 +11,7 @@ module SpiderGazelle
 
 
         def initialize
-            @thread = ::Libuv::Loop.default
+            @thread = ::Libuv::Reactor.default
             @logger = Logger.instance
             @running = false
             @shutdown = method(:shutdown)
@@ -21,18 +23,15 @@ module SpiderGazelle
                 @thread.schedule block
             else
                 @running = true
-                @thread.run { |logger|
-                    logger.progress method(:log)
-                    
-                    # Listen for the signal to shutdown
-                    @thread.signal :INT, @shutdown
-
+                @thread.notifier method(:log)
+                @thread.on_program_interrupt @shutdown
+                @thread.run { |thread|
                     block.call
                 }
             end
         end
 
-        def shutdown(_ = nil)
+        def shutdown
             if @shutdown_called
                 @logger.warn "Shutdown called twice! Callstack:\n#{caller.join("\n")}"
                 return
@@ -54,12 +53,13 @@ module SpiderGazelle
         end
 
         # This is an unhandled error on the Libuv Event loop
-        def log(level, errorid, error)
-            msg = ''
+        def log(error, context, trace = nil)
+            msg = String.new
             if error.respond_to?(:backtrace)
-                msg << "unhandled exception: #{error.message} (#{level} - #{errorid})"
+                msg << "unhandled exception: #{error.message} (#{context})"
                 backtrace = error.backtrace
                 msg << "\n#{backtrace.join("\n")}" if backtrace
+                msg << "\n#{trace.join("\n")}" if trace
             else
                 msg << "unhandled exception: #{args}"
             end

data/lib/spider-gazelle/signaller.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'libuv'
 
 
@@ -11,7 +13,7 @@ module SpiderGazelle
 
 
         def initialize
-            @thread = ::Libuv::Loop.default
+            @thread = ::Libuv::Reactor.default
             @logger = Logger.instance
 
             # This is used to check if an instance of spider-gazelle is already running
@@ -69,7 +71,7 @@ module SpiderGazelle
         end
 
         def general_failure
-            @pipe.write "\x02Signaller general_failure\x03".freeze
+            @pipe.write "\x02Signaller general_failure\x03"
         rescue
         ensure
             Reactor.instance.shutdown
@@ -91,7 +93,7 @@ module SpiderGazelle
                 @is_client = true
                 @is_connected = true
 
-                @logger.verbose "Client connected to SG Master".freeze
+                @logger.verbose "Client connected to SG Master"
                 
                 require 'uv-rays/buffered_tokenizer'
                 @parser = ::UV::BufferedTokenizer.new({
@@ -172,6 +174,8 @@ module SpiderGazelle
             #@logger.error "Master pipe went missing: #{reason}"
             # Server most likely exited
             # We'll shutdown here
+            STDERR.puts "\n\npanic! #{reason.inspect}\n\n\n"
+            STDERR.flush
             Reactor.instance.shutdown
         end
 
@@ -188,13 +192,13 @@ module SpiderGazelle
                 case result
                 when :validated
                     @validated.each do |old|
-                        old.write "\x02update\x03".freeze
+                        old.write "\x02update\x03"
                     end
                     @validated << client
                     if @validated.length > 1
-                        client.write "\x02wait\x03".freeze
+                        client.write "\x02wait\x03"
                     else
-                        client.write "\x02ready\x03".freeze
+                        client.write "\x02ready\x03"
                     end
                     @logger.verbose { "Client <0x#{client.object_id.to_s(16)}> connection was validated" }
                 when :close_connection

data/lib/spider-gazelle/signaller/signal_parser.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'uv-rays'
 
 

data/lib/spider-gazelle/spider.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spider-gazelle/spider/binding'        # Holds a reference to a bound port
 require 'securerandom'
 
@@ -67,13 +69,13 @@ module SpiderGazelle
             load_promise.then do
                 # Check a shutdown request didn't occur as we were loading
                 if @running
-                    @logger.verbose "All gazelles running".freeze
+                    @logger.verbose "All gazelles running"
 
                     # This happends on the master thread so we don't need to check
                     # for the shutdown events here
                     bind_application_ports
                 else
-                    @logger.warn "A shutdown event occured while loading".freeze
+                    @logger.warn "A shutdown event occured while loading"
                     perform_shutdown
                 end
             end
@@ -125,7 +127,7 @@ module SpiderGazelle
             rescue
             end
 
-            shutdown = false
+            @shutdown = false
             check = method(:check_credentials)
             @pipe.bind(@pipe_file) do |client|
                 @logger.verbose { "Gazelle <0x#{client.object_id.to_s(16)}> connection made" }
@@ -145,8 +147,8 @@ module SpiderGazelle
                     rescue
                     ensure
                         @gazelles.delete client
-                        if !shutdown
-                            shutdown = true
+                        if !@shutdown
+                            @shutdown = true
                             @signaller.general_failure
                         end
                     end
@@ -243,7 +245,7 @@ module SpiderGazelle
 
                     @threads = []
                     count.times do
-                        thread = ::Libuv::Loop.new
+                        thread = ::Libuv::Reactor.new
                         @threads << thread
 
                         Thread.new { load_gazelle_thread(reactor, thread, mode, options) }
@@ -266,10 +268,18 @@ module SpiderGazelle
         end
 
         def load_gazelle_thread(reactor, thread, mode, options)
-            thread.run do |logger|
-                # Log any unhandled errors
-                logger.progress reactor.method(:log)
-
+            # Log any unhandled errors
+            thread.notifier reactor.method(:log)
+            # Give current requests 5 seconds to complete
+            thread.on_program_interrupt do
+                timer = thread.timer {
+                    puts "Forcing gazelle exit"
+                    thread.stop
+                }
+                timer.unref
+                timer.start(5000)
+            end
+            thread.run do |thread|
                 # Start the gazelle
                 ::SpiderGazelle::Gazelle.new(thread, :thread).run!(options)
             end
@@ -283,9 +293,9 @@ module SpiderGazelle
             if @running
                 @thread.schedule do
                     if result
-                        @logger.verbose "Gazelle process exited with exit status 0".freeze
+                        @logger.verbose "Gazelle process exited with exit status 0"
                     else
-                        @logger.error "Gazelle process exited unexpectedly".freeze
+                        @logger.error "Gazelle process exited unexpectedly"
                     end
                      
                     @signaller.general_failure
@@ -330,6 +340,7 @@ module SpiderGazelle
 
         def shutdown_gazelles
             @bound = false
+            @shutdown = true
             promises = []
 
             @iterator_source.each do |mode, gazelles|