spider-gazelle 2.0.1 → 2.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d572d56238befc1bb320a35caa722a5b5862de98
-  data.tar.gz: 543e26733659f208fd6f2cbb8c634a2082b3a01b
+  metadata.gz: ce0882fd3ec8b1ae9319cff47eb1ed6504b18c2e
+  data.tar.gz: 9ac4f207d5fb67c773ae7775d42f61b1dfc8a309
 SHA512:
-  metadata.gz: 053e8b2128d068779d21d5ffd8f312265895b61d7da0ccceb8dea262c2fb6026dbcd3bf4f41bdc4f7809a0d7a6bc3baf4a56be58a42a31d05e33cad4b7af1eb6
-  data.tar.gz: 8c8a6ee3c20692c3173b2a0240818223cf4cd9c967f007db3fde7e6186f273234c81e7419906b787325c5e39ff0b6e6ae3e858e0625ad9f13de7ca8b3256638f
+  metadata.gz: 0cc6c0b91aaf2dd1299267df06682ea445f5d2b5811a41f83cdb708f5032805513dff7c7872371f982106154e7d5dcbe7f08d76c4506a5064b3fdc5f044cae19
+  data.tar.gz: cfd13c84de17f19f91832a9e29caef019c329cabf6b29de0255512f512b66ba2a44e0128598153c92e80ce3498687f9b8eddd7cc6c6fc810dda763c62393c3f8

data/README.md

@@ -1,6 +1,7 @@
 # spider-gazelle
 
-[<img src="https://codeclimate.com/github/cotag/spider-gazelle.png" />](https://codeclimate.com/github/cotag/spider-gazelle)
+[<img src="https://codeclimate.com/github/cotag/spider-gazelle/badges/gpa.svg" />](https://codeclimate.com/github/cotag/spider-gazelle)
+[![Build Status](https://travis-ci.org/cotag/spider-gazelle.svg?branch=master)](https://travis-ci.org/cotag/spider-gazelle)
 
 
 A fast, parallel and concurrent web server for ruby
@@ -28,7 +29,7 @@ Look out! Here comes the Spidergazelle!
 
 ## Options
 
-For other command line options look at [the source](/bin/sg)
+For other command line options look at [the source](/lib/spider-gazelle/options.rb)
 
 
 ## Community support

data/bin/sg

@@ -1,4 +1,6 @@
 #!/usr/bin/env ruby
 
+require 'spider-gazelle/version'
+puts "Launching spider-gazelle v#{::SpiderGazelle::VERSION}"
 require 'spider-gazelle'
 SpiderGazelle::LaunchControl.instance.exec(ARGV)

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

@@ -79,10 +79,9 @@ module SpiderGazelle
                 @logger = logger
 
                 @work = method(:work)
-                @work_complete = proc { |result|
-                    request = @processing
+                @work_complete = proc { |request, result|
                     if request.is_async && !request.hijacked
-                        if result.is_a? Fixnum
+                        if result.is_a?(Fixnum) && !request.defer.resolved?
                             # TODO:: setup timeout for async response
                         end
                     else
@@ -91,7 +90,6 @@ module SpiderGazelle
                     end
                 }
 
-                @async_callback = method(:async_callback)
                 @queue_response = method(:queue_response)
 
                 # The parser state for this instance
@@ -182,7 +180,7 @@ module SpiderGazelle
             # Parser Callbacks
             # ----------------
             def start_parsing
-                @parsing = Request.new @thread, @app, @port, @remote_ip, @scheme, @async_callback
+                @parsing = Request.new @thread, @app, @port, @remote_ip, @scheme
             end
 
             REQUEST_METHOD = 'REQUEST_METHOD'.freeze
@@ -190,6 +188,7 @@ module SpiderGazelle
                 @parsing.env[REQUEST_METHOD] = @state.http_method.to_s
             end
 
+            ASYNC = "async.callback".freeze
             def finished_parsing
                 request = @parsing
                 @parsing = nil
@@ -200,6 +199,12 @@ module SpiderGazelle
                     @socket.stop_read
                 end
 
+                # Process the async request in the same way as Mizuno
+                # See: http://polycrystal.org/2012/04/15/asynchronous_responses_in_rack.html
+                # Process a response that was marked as async.
+                request.env[ASYNC] = proc { |data|
+                    @thread.schedule { request.defer.resolve(data) }
+                }
                 request.upgrade = @state.upgrade?
                 @requests << request
                 process_next unless @processing
@@ -228,28 +233,13 @@ module SpiderGazelle
 
             EMPTY_RESPONSE = [''.freeze].freeze
             def work
+                request = @processing
                 begin
-                    @processing.execute!
+                    [request, request.execute!]
                 rescue StandardError => e
                     @logger.print_error e, 'framework error'
                     @processing.keep_alive = false
-                    [500, {}, EMPTY_RESPONSE]
-                end
-            end
-
-            # Process the async request in the same way as Mizuno
-            # See: http://polycrystal.org/2012/04/15/asynchronous_responses_in_rack.html
-            def async_callback(data)
-                @thread.schedule { callback(data) }
-            end
-
-            # Process a response that was marked as async. Save the data if the request hasn't responded yet
-            def callback(data)
-                request = @processing
-                if request && request.is_async
-                    request.defer.resolve(data)
-                else
-                    @logger.warn "Received async callback and there are no pending requests. Data was:\n#{data}"
+                    [request, [500, {}, EMPTY_RESPONSE]]
                 end
             end
 
@@ -477,14 +467,15 @@ module SpiderGazelle
                 end
             end
 
-            ERROR_400_RESPONSE = "HTTP/1.1 400 Bad Request\r\n\r\n".freeze
+            ERROR_400_RESPONSE = "HTTP/1.1 400 Bad Request\r\nConnection: close\r\nContent-Length: 0\r\n\r\n".freeze
             def send_parsing_error
                 @logger.info "Parsing error!"
+                @socket.stop_read
                 @socket.write ERROR_400_RESPONSE
                 @socket.shutdown
             end
 
-            ERROR_500_RESPONSE = "HTTP/1.1 500 Internal Server Error\r\n\r\n".freeze
+            ERROR_500_RESPONSE = "HTTP/1.1 500 Internal Server Error\r\nConnection: close\r\nContent-Length: 0\r\n\r\n".freeze
             def send_internal_error
                 @logger.info "Internal error"
                 @socket.stop_read

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

@@ -42,9 +42,8 @@ module SpiderGazelle
         SERVER_PORT = "SERVER_PORT".freeze
         REMOTE_ADDR = "REMOTE_ADDR".freeze
         RACK_URL_SCHEME = "rack.url_scheme".freeze
-        ASYNC = "async.callback".freeze
 
-        def initialize(thread, app, port, remote_ip, scheme, async_callback)
+        def initialize(thread, app, port, remote_ip, scheme)
             super(thread, thread.defer)
 
             @app = app
@@ -55,7 +54,6 @@ module SpiderGazelle
             @env[SERVER_PORT] = port
             @env[REMOTE_ADDR] = remote_ip
             @env[RACK_URL_SCHEME] = scheme
-            @env[ASYNC] = async_callback
         end
 
 
@@ -85,6 +83,8 @@ module SpiderGazelle
         USE_HTTP2 = 'h2c'.freeze
 
 
+
+
         def execute!
             @env[CONTENT_LENGTH] = @env.delete(HTTP_CONTENT_LENGTH) || @body.length
             @env[CONTENT_TYPE] = @env.delete(HTTP_CONTENT_TYPE) || DEFAULT_TYPE

data/lib/spider-gazelle/options.rb

@@ -160,6 +160,9 @@ module SpiderGazelle
 
                 # isolation and process mode don't mix
                 options[:isolate] = false if options[:mode] == :process
+
+                # Force no_ipc mode on Windows (sockets over pipes are not working in threaded mode)
+                options[:mode] = :no_ipc if ::FFI::Platform.windows? && options[:mode] == :thread
             end
 
             options

data/lib/spider-gazelle/version.rb

@@ -0,0 +1,5 @@
+
+module SpiderGazelle
+    VERSION = '2.0.2'.freeze
+    EXEC_NAME = 'sg'.freeze
+end

data/lib/spider-gazelle.rb

@@ -2,6 +2,7 @@ require 'thread'
 require 'singleton'
 
 
+require 'spider-gazelle/version'
 require 'spider-gazelle/options'
 require 'spider-gazelle/logger'
 require 'spider-gazelle/reactor'
@@ -9,8 +10,6 @@ require 'spider-gazelle/signaller'
 
 
 module SpiderGazelle
-    VERSION = '2.0.1'.freeze
-    EXEC_NAME = 'sg'.freeze
     INTERNAL_PIPE_BACKLOG = 128
 
     # Signaller is used to communicate:

data/spec/http1_spec.rb

@@ -1,3 +1,4 @@
+require 'spider-gazelle'
 require 'spider-gazelle/gazelle/http1'
 
 
@@ -100,6 +101,53 @@ describe ::SpiderGazelle::Gazelle::Http1 do
         ])
     end
 
+    it "should fill out the environment properly", http1: true do
+        app = lambda do |env|
+            expect(env['REQUEST_URI']).to eq('/?test=ing')
+            expect(env['REQUEST_PATH']).to eq('/')
+            expect(env['QUERY_STRING']).to eq('test=ing')
+            expect(env['SERVER_NAME']).to eq('spider.gazelle.net')
+            expect(env['SERVER_PORT']).to eq(3000)
+            expect(env['REMOTE_ADDR']).to eq('127.0.0.1')
+            expect(env['rack.url_scheme']).to eq('http')
+
+            body = 'Hello, World!'
+            [200, {'Content-Type' => 'text/plain', 'Content-Length' => body.length.to_s}, [body]]
+        end
+
+        @loop.run {
+            @http1.load(@socket, @port, app, @app_mode, @tls)
+            @http1.parse("GET /?test=ing HTTP/1.1\r\nHost: spider.gazelle.net:3000\r\nConnection: Close\r\n\r\n")
+        }
+
+        expect(@shutdown_called).to be == 1
+        expect(@close_called).to be == 0
+    end
+
+    it "should respond with a chunked response", http1: true do
+        app = lambda do |env|
+            body = ['Hello', ',', ' World!']
+            [200, {'Content-Type' => 'text/plain'}, body]
+        end
+        writes = []
+
+        @loop.run {
+            @http1.load(@socket, @port, app, @app_mode, @tls)
+            @http1.parse("GET / HTTP/1.1\r\nConnection: Close\r\n\r\n")
+
+            @socket.write_cb = proc { |data|
+                writes << data
+            }
+        }
+
+        expect(@shutdown_called).to be == 1
+        expect(@close_called).to be == 0
+        expect(writes).to eq([
+            "HTTP/1.1 200 OK\r\nContent-Type: text/plain\r\nTransfer-Encoding: chunked\r\nConnection: close\r\n\r\n",
+            "5\r\nHello\r\n", "1\r\n,\r\n", "7\r\n World!\r\n", "0\r\n\r\n"
+        ])
+    end
+
     it "should process a single request and keep the connection open", http1: true do
         app = lambda do |env|
             body = 'Hello, World!'
@@ -129,33 +177,162 @@ describe ::SpiderGazelle::Gazelle::Http1 do
         ])
     end
 
-    it "should fill out the environment properly", http1: true do
+    it "should process pipelined requests in order", http1: true do
+        current = 0
+        order = []
         app = lambda do |env|
-            expect(env['REQUEST_URI']).to eq('/?test=ing')
-            expect(env['REQUEST_PATH']).to eq('/')
-            expect(env['QUERY_STRING']).to eq('test=ing')
-            expect(env['SERVER_NAME']).to eq('spider.gazelle.net')
-            expect(env['SERVER_PORT']).to eq(3000)
-            expect(env['REMOTE_ADDR']).to eq('127.0.0.1')
-            expect(env['rack.url_scheme']).to eq('http')
+            case env['REQUEST_PATH']
+            when '/1'
+                order << 1
+                current = 1
+                body = 'Hello, World!'
+                [200, {'Content-Type' => 'text/plain', 'Content-Length' => body.length.to_s}, [body]]
+            when '/2'
+                order << 2
+                current = 2
+                body = ['Hello,', ' World!']
+                [200, {'Content-Type' => 'text/plain'}, body]
+            when '/3'
+                order << 3
+                current = 3
+                body = 'Happiness'
+                [200, {'Content-Type' => 'text/plain', 'Content-Length' => body.length.to_s}, [body]]
+            when '/4'
+                order << 4
+                current = 4
+                body = 'is a warm gun'
+                [200, {'Content-Type' => 'text/plain', 'Content-Length' => body.length.to_s}, [body]]
+            end
+        end
 
-            body = 'Hello, World!'
-            [200, {'Content-Type' => 'text/plain', 'Content-Length' => body.length.to_s}, [body]]
+        writes = []
+        @loop.run {
+            @http1.load(@socket, @port, app, @app_mode, @tls)
+            @http1.parse("GET /1 HTTP/1.1\r\n\r\nGET /2 HTTP/1.1\r\n\r\nGET /3 HTTP/1.1\r\n\r\n")
+            @http1.parse("GET /4 HTTP/1.1\r\nConnection: Close\r\n\r\n")
+
+            @socket.write_cb = proc { |data|
+                order << current
+                writes << data
+            }
+        }
+
+        expect(@shutdown_called).to be == 1
+        expect(@close_called).to be == 0
+        expect(order).to eq([1,1,1, 2,2,2,2,2, 3,3,3, 4,4,4])
+        expect(writes).to eq([
+            "HTTP/1.1 200 OK\r\nContent-Type: text/plain\r\nContent-Length: 13\r\n\r\n",
+            "Hello, World!",
+            "HTTP/1.1 200 OK\r\nContent-Type: text/plain\r\nTransfer-Encoding: chunked\r\n\r\n",
+            "6\r\nHello,\r\n", "7\r\n World!\r\n", "0\r\n\r\n",
+            "HTTP/1.1 200 OK\r\nContent-Type: text/plain\r\nContent-Length: 9\r\n\r\n",
+            "Happiness",
+            "HTTP/1.1 200 OK\r\nContent-Type: text/plain\r\nContent-Length: 13\r\nConnection: close\r\n\r\n",
+            "is a warm gun"
+        ])
+    end
+
+    it "should process a single async request and close the connection", http1: true do
+        app = lambda do |env|
+            expect(env['SERVER_PORT']).to eq(80)
+
+            Thread.new do
+                body = 'Hello, World!'
+                env['async.callback'].call [200, {'Content-Type' => 'text/plain', 'Content-Length' => body.length.to_s}, [body]]
+            end
+
+            throw :async
         end
+        writes = []
 
         @loop.run {
             @http1.load(@socket, @port, app, @app_mode, @tls)
-            @http1.parse("GET /?test=ing HTTP/1.1\r\nHost: spider.gazelle.net:3000\r\nConnection: Close\r\n\r\n")
+            @http1.parse("GET / HTTP/1.1\r\nConnection: Close\r\n\r\n")
+
+            @socket.write_cb = proc { |data|
+                writes << data
+            }
         }
 
         expect(@shutdown_called).to be == 1
         expect(@close_called).to be == 0
+        expect(writes).to eq([
+            "HTTP/1.1 200 OK\r\nContent-Type: text/plain\r\nContent-Length: 13\r\nConnection: close\r\n\r\n",
+            "Hello, World!"
+        ])
     end
 
-    it "should respond with a chunked response", http1: true do
+    it "should process pipelined async requests in order", http1: true do
+        current = 0
+        order = []
         app = lambda do |env|
-            body = ['Hello', ',', ' World!']
-            [200, {'Content-Type' => 'text/plain'}, body]
+            Thread.new do
+                env['async.callback'].call case env['REQUEST_PATH']
+                when '/1'
+                    order << 1
+                    current = 1
+                    body = 'Hello, World!'
+                    [200, {'Content-Type' => 'text/plain', 'Content-Length' => body.length.to_s}, [body]]
+                when '/2'
+                    order << 2
+                    current = 2
+                    body = ['Hello,', ' World!']
+                    [200, {'Content-Type' => 'text/plain'}, body]
+                when '/3'
+                    order << 3
+                    current = 3
+                    body = 'Happiness'
+                    [200, {'Content-Type' => 'text/plain', 'Content-Length' => body.length.to_s}, [body]]
+                when '/4'
+                    order << 4
+                    current = 4
+                    body = 'is a warm gun'
+                    [200, {'Content-Type' => 'text/plain', 'Content-Length' => body.length.to_s}, [body]]
+                end
+            end
+
+            throw :async
+        end
+
+        writes = []
+        @loop.run {
+            @http1.load(@socket, @port, app, @app_mode, @tls)
+            @http1.parse("GET /1 HTTP/1.1\r\n\r\nGET /2 HTTP/1.1\r\n\r\nGET /3 HTTP/1.1\r\n\r\n")
+            @http1.parse("GET /4 HTTP/1.1\r\nConnection: Close\r\n\r\n")
+
+            @socket.write_cb = proc { |data|
+                order << current
+                writes << data
+            }
+        }
+
+        expect(@shutdown_called).to be == 1
+        expect(@close_called).to be == 0
+        expect(order).to eq([1,1,1, 2,2,2,2,2, 3,3,3, 4,4,4])
+        expect(writes).to eq([
+            "HTTP/1.1 200 OK\r\nContent-Type: text/plain\r\nContent-Length: 13\r\n\r\n",
+            "Hello, World!",
+            "HTTP/1.1 200 OK\r\nContent-Type: text/plain\r\nTransfer-Encoding: chunked\r\n\r\n",
+            "6\r\nHello,\r\n", "7\r\n World!\r\n", "0\r\n\r\n",
+            "HTTP/1.1 200 OK\r\nContent-Type: text/plain\r\nContent-Length: 9\r\n\r\n",
+            "Happiness",
+            "HTTP/1.1 200 OK\r\nContent-Type: text/plain\r\nContent-Length: 13\r\nConnection: close\r\n\r\n",
+            "is a warm gun"
+        ])
+    end
+
+    it "should process a single async request and not suffer from race conditions", http1: true do
+        app = lambda do |env|
+            expect(env['SERVER_PORT']).to eq(80)
+
+            Thread.new do
+                body = 'Hello, World!'
+                env['async.callback'].call [200, {'Content-Type' => 'text/plain', 'Content-Length' => body.length.to_s}, [body]]
+            end
+
+            sleep 0.5
+
+            throw :async
         end
         writes = []
 
@@ -170,6 +347,12 @@ describe ::SpiderGazelle::Gazelle::Http1 do
 
         expect(@shutdown_called).to be == 1
         expect(@close_called).to be == 0
-        expect(writes).to eq(["HTTP/1.1 200 OK\r\nContent-Type: text/plain\r\nTransfer-Encoding: chunked\r\nConnection: close\r\n\r\n", "5\r\nHello\r\n", "1\r\n,\r\n", "7\r\n World!\r\n", "0\r\n\r\n"])
+        expect(writes).to eq([
+            "HTTP/1.1 200 OK\r\nContent-Type: text/plain\r\nContent-Length: 13\r\nConnection: close\r\n\r\n",
+            "Hello, World!"
+        ])
+
+        # Allow the worker thread to complete so we exit cleanly
+        sleep 1
     end
 end

data/spider-gazelle.gemspec

@@ -1,7 +1,7 @@
 # -*- encoding: utf-8 -*-
 $:.push File.expand_path("../lib", __FILE__)
 
-require 'spider-gazelle'
+require 'spider-gazelle/version'
 version = SpiderGazelle::VERSION
 
 Gem::Specification.new do |s|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spider-gazelle
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.0.2
 platform: ruby
 authors:
 - Stephen von Takach
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-23 00:00:00.000000000 Z
+date: 2015-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -167,6 +167,7 @@ files:
 - lib/spider-gazelle/spider.rb
 - lib/spider-gazelle/spider/binding.rb
 - lib/spider-gazelle/upgrades/websocket.rb
+- lib/spider-gazelle/version.rb
 - spec/http1_spec.rb
 - spec/rack_lock_spec.rb
 - spider-gazelle.gemspec