yahns 1.8.0 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0bea696fff5f5d58044ab6f62df4b89d0b03a4d5
-  data.tar.gz: 7936ab7581a763fac0e466a98f5d88e8ff1e8a1a
+  metadata.gz: 49368448f90a245e5b9e66d4be300840d6cecfa9
+  data.tar.gz: 2b97d5ff7b0ca846366ea32397ae99bd27eb4cf2
 SHA512:
-  metadata.gz: a8ead2093e262430942ffbd4fc438d1160903b0fbb5c61f32f2339022d46488d9e7ad370714494f2232e09a1759e3c2d4b8216e1dad68f5b0abcf82cccf3abf1
-  data.tar.gz: cd8b7d89b7341c7aa1da9681ccadff2d9d2a828107d8b1ca37354daffeee8b46039b752babd326ef5e51ecb1b97720e3a75d2c7ea55e687758b17aa87e3ee6b8
+  metadata.gz: 7da4504be2239c1c8387a51a88e3d5a025a7b592156e2856b190a1ce196dd24c5a726597ad13e71ba4d17fc7473140e8bdc66ae70522391cb5e1ae77dc894782
+  data.tar.gz: f12f41d4b2229a86cdf243706ab71c4668da13e483b462f1845d68ac67cadadd05b6e835c45a5c8d0cedba538f1ec80dbb18ab199b587182afe6725e5d8c949e

data/GIT-VERSION-FILE

@@ -1 +1 @@
-VERSION = 1.8.0
+VERSION = 1.9.0

data/GIT-VERSION-GEN

@@ -4,7 +4,7 @@
 CONSTANT = "Yahns::VERSION"
 RVF = "lib/yahns/version.rb"
 GVF = "GIT-VERSION-FILE"
-DEF_VER = "v1.8.0"
+DEF_VER = "v1.9.0"
 vn = DEF_VER
 
 # First see if there is a version file (included in release tarballs),

data/NEWS

@@ -1,3 +1,37 @@
+yahns 1.9.0 - minor updates / 2015-07-21
+----------------------------------------
+
+This release improves socket inheritance support.  TCP socket
+options are now applied to inherited sockets.  We also emulate
+the sd_listen_fds function to allow inheriting sockets from
+systemd.
+
+HTTP status strings are now generated dynamically, allowing
+applications to modify Rack::Utils::HTTP_STATUS_CODES to
+apply changes in the Rack response.  Unfortunately, this leads
+to minor (likely unnoticeable) performance regressions.
+
+However, our code is not optimized for Ruby 2.2+, so users on
+the latest released Ruby will benefit from reduced inline cache
+and constant lookups as we reduced our constant footprint.
+Expect further minor performance regressions if you are running
+Ruby 2.2 and earlier.
+
+For Ruby 2.2 users, overall performance should be largely
+unchanged from 1.7.0 to 1.8.0
+
+shortlog of changes since 1.7.0:
+
+* use opt_str_freeze for Hash#delete
+* test/helper: warn atomically
+* generate response status strings dynamically
+* reduce constants and optimize for Ruby 2.2+
+* http_response: reduce bytecode size
+* apply TCP socket options on inherited sockets
+* test/test_rack_hijack.rb: try to increase test reliability
+* emulate sd_listen_fds for systemd support
+* test/test_rack_hijack: ensure proper ordering of log messages
+
 yahns 1.8.0 - minor updates / 2015-06-11
 ----------------------------------------
 

data/lib/yahns/http_client.rb

@@ -11,12 +11,6 @@ class Yahns::HttpClient < Kgio::Socket # :nodoc:
   include Yahns::HttpResponse
   QEV_FLAGS = Yahns::Queue::QEV_RD # used by acceptor
 
-  # A frozen format for this is about 15% faster (note from Mongrel)
-  REMOTE_ADDR = 'REMOTE_ADDR'.freeze
-  RACK_INPUT = 'rack.input'.freeze
-  RACK_HIJACK = 'rack.hijack'.freeze
-  RACK_HIJACK_IO = "rack.hijack_io".freeze
-
   # called from acceptor thread
   def yahns_init
     @hs = Unicorn::HttpRequest.new
@@ -206,9 +200,9 @@ class Yahns::HttpClient < Kgio::Socket # :nodoc:
     # input is nil if we needed to wait for writability with
     # check_client_connection
     if input
-      env[REMOTE_ADDR] = @kgio_addr
-      env[RACK_HIJACK] = self
-      env[RACK_INPUT] = input
+      env['REMOTE_ADDR'] = @kgio_addr
+      env['rack.hijack'] = self
+      env['rack.input'] = input
 
       if k.check_client_connection && @hs.headers?
         rv = do_ccc and return rv
@@ -262,7 +256,7 @@ class Yahns::HttpClient < Kgio::Socket # :nodoc:
   # this is the env["rack.hijack"] callback exposed to the Rack app
   def call
     hijack_cleanup
-    @hs.env[RACK_HIJACK_IO] = self
+    @hs.env['rack.hijack_io'] = self
   end
 
   def response_hijacked(fn)
@@ -300,7 +294,7 @@ class Yahns::HttpClient < Kgio::Socket # :nodoc:
   end
 
   def app_hijacked?(env, body)
-    return false unless env.include?(RACK_HIJACK_IO)
+    return false unless env.include?('rack.hijack_io'.freeze)
     body.close if body.respond_to?(:close)
     true
   end

data/lib/yahns/http_response.rb

@@ -22,14 +22,8 @@ module Yahns::HttpResponse # :nodoc:
     end
   end
 
-  # avoid GC overhead for frequently used-strings:
-  CONN_KA = "Connection: keep-alive\r\n\r\n"
-  CONN_CLOSE = "Connection: close\r\n\r\n"
-  Z = ""
+  # avoid GC overhead for frequently used-strings/objects:
   CCC_RESPONSE_START = [ 'HTTP', '/1.1 ' ]
-  RESPONSE_START = CCC_RESPONSE_START.join
-  REQUEST_METHOD = "REQUEST_METHOD"
-  HEAD = "HEAD"
 
   # no point in using one without the other, these have been in Linux
   # for ages
@@ -46,7 +40,7 @@ module Yahns::HttpResponse # :nodoc:
   end
 
   def response_start
-    @hs.response_start_sent ? Z : RESPONSE_START
+    @hs.response_start_sent ? ''.freeze : 'HTTP/1.1 '.freeze
   end
 
   def response_wait_write(rv)
@@ -59,7 +53,7 @@ module Yahns::HttpResponse # :nodoc:
   end
 
   def err_response(code)
-    "#{response_start}#{CODES[code]}\r\n\r\n"
+    "#{response_start}#{code} #{Rack::Utils::HTTP_STATUS_CODES[code]}\r\n\r\n"
   end
 
   def response_header_blocked(ret, header, body, alive, offset, count)
@@ -114,23 +108,22 @@ module Yahns::HttpResponse # :nodoc:
     end
   end
 
-  def kv_str(key, value)
-    if value =~ /\n/
+  def kv_str(buf, key, value)
+    if value.include?("\n".freeze)
       # avoiding blank, key-only cookies with /\n+/
-      value.split(/\n+/).map! { |v| "#{key}: #{v}\r\n" }.join
+      value.split(/\n+/).each { |v| buf << "#{key}: #{v}\r\n" }
     else
-      "#{key}: #{value}\r\n"
+      buf << "#{key}: #{value}\r\n"
     end
   end
 
   def have_more?(value)
-    value.to_i > 0 && @hs.env[REQUEST_METHOD] != HEAD
+    value.to_i > 0 && @hs.env['REQUEST_METHOD'] != 'HEAD'.freeze
   end
 
   # writes the rack_response to socket as an HTTP response
   # returns :wait_readable, :wait_writable, :forget, or nil
   def http_response_write(status, headers, body)
-    status = CODES[status.to_i] || status
     offset = 0
     count = hijack = nil
     k = self.class
@@ -138,7 +131,10 @@ module Yahns::HttpResponse # :nodoc:
     flags = MSG_DONTWAIT
 
     if @hs.headers?
-      buf = "#{response_start}#{status}\r\nDate: #{httpdate}\r\n"
+      code = status.to_i
+      msg = Rack::Utils::HTTP_STATUS_CODES[code]
+      buf = "#{response_start}#{msg ? %Q(#{code} #{msg}) : status}\r\n" \
+            "Date: #{httpdate}\r\n"
       headers.each do |key, value|
         case key
         when %r{\ADate\z}i
@@ -148,20 +144,21 @@ module Yahns::HttpResponse # :nodoc:
             offset = $1.to_i
             count = $2.to_i - offset + 1
           end
-          buf << kv_str(key, value)
+          kv_str(buf, key, value)
         when %r{\AConnection\z}i
           # allow Rack apps to tell us they want to drop the client
           alive = false if value =~ /\bclose\b/i
         when %r{\AContent-Length\z}i
           flags |= MSG_MORE if have_more?(value)
-          buf << kv_str(key, value)
+          kv_str(buf, key, value)
         when "rack.hijack"
           hijack = value
         else
-          buf << kv_str(key, value)
+          kv_str(buf, key, value)
         end
       end
-      buf << (alive ? CONN_KA : CONN_CLOSE)
+      buf << (alive ? "Connection: keep-alive\r\n\r\n".freeze
+                    : "Connection: close\r\n\r\n".freeze)
       case rv = kgio_syssend(buf, flags)
       when nil # all done, likely
         break
@@ -255,7 +252,7 @@ module Yahns::HttpResponse # :nodoc:
   # returns nil on success
   # returns :close, :wait_writable, or :wait_readable
   def http_100_response(env)
-    env.delete("HTTP_EXPECT") =~ /\A100-continue\z/i or return
+    env.delete('HTTP_EXPECT'.freeze) =~ /\A100-continue\z/i or return
     buf = @hs.response_start_sent ? "100 Continue\r\n\r\nHTTP/1.1 ".freeze
                                   : "HTTP/1.1 100 Continue\r\n\r\n".freeze
 

data/lib/yahns/max_body.rb

@@ -28,17 +28,13 @@ class Yahns::MaxBody # :nodoc:
     @limit = limit
   end
 
-  RACK_INPUT = "rack.input".freeze # :nodoc:
-  CONTENT_LENGTH = "CONTENT_LENGTH" # :nodoc:
-  HTTP_TRANSFER_ENCODING = "HTTP_TRANSFER_ENCODING" # :nodoc:
-
   # our main Rack middleware endpoint
   def call(env) # :nodoc:
     catch(:yahns_EFBIG) do
-      len = env[CONTENT_LENGTH]
+      len = env['CONTENT_LENGTH']
       if len && len.to_i > @limit
         return err
-      elsif /\Achunked\z/i =~ env[HTTP_TRANSFER_ENCODING]
+      elsif /\Achunked\z/i =~ env['HTTP_TRANSFER_ENCODING']
         limit_input!(env)
       end
       @app.call(env)
@@ -51,9 +47,9 @@ class Yahns::MaxBody # :nodoc:
   end
 
   def limit_input!(env) # :nodoc:
-    input = env[RACK_INPUT]
+    input = env['rack.input']
     klass = input.respond_to?(:rewind) ? RewindableWrapper : Wrapper
-    env[RACK_INPUT] = klass.new(input, @limit)
+    env['rack.input'] = klass.new(input, @limit)
   end
 end
 require_relative 'max_body/wrapper'

data/lib/yahns/proxy_http_response.rb

@@ -38,7 +38,8 @@ module Yahns::HttpResponse # :nodoc:
     end
     # try to write something, but don't care if we fail
     Integer === code and
-      kgio_trywrite("HTTP/1.1 #{CODES[code]}\r\n\r\n") rescue nil
+      kgio_trywrite("HTTP/1.1 #{code} #{
+                     Rack::Utils::HTTP_STATUS_CODES[code]}\r\n\r\n") rescue nil
 
     shutdown rescue nil
     req_res.shutdown rescue nil
@@ -59,16 +60,16 @@ module Yahns::HttpResponse # :nodoc:
   # returns nil if completely done
   def proxy_response_start(res, tip, kcar, req_res)
     status, headers = res
-    si = status.to_i
-    status = CODES[si] || status
+    code = status.to_i
+    msg = Rack::Utils::HTTP_STATUS_CODES[code]
     env = @hs.env
-    have_body = !Rack::Utils::STATUS_WITH_NO_ENTITY_BODY.include?(si) &&
-                env[REQUEST_METHOD] != HEAD
+    have_body = !Rack::Utils::STATUS_WITH_NO_ENTITY_BODY.include?(code) &&
+                env['REQUEST_METHOD'] != 'HEAD'.freeze
     flags = MSG_DONTWAIT
     alive = @hs.next? && self.class.persistent_connections
     response_headers = env['yahns.proxy_pass.response_headers']
 
-    res = "HTTP/1.1 #{status}\r\n"
+    res = "HTTP/1.1 #{msg ? %Q(#{code} #{msg}) : status}\r\n"
     headers.each do |key,value| # n.b.: headers is an Array of 2-element Arrays
       case key
       when /\A(?:Connection|Keep-Alive)\z/i
@@ -90,7 +91,8 @@ module Yahns::HttpResponse # :nodoc:
 
     # For now, do not add a Date: header, assume upstream already did it
     # but do not care if they did not
-    res << (alive ? CONN_KA : CONN_CLOSE)
+    res << (alive ? "Connection: keep-alive\r\n\r\n"
+                  : "Connection: close\r\n\r\n")
 
     # send the headers
     case rv = kgio_syssend(res, flags)

data/lib/yahns/server.rb

@@ -312,12 +312,23 @@ class Yahns::Server # :nodoc:
     # because that can completely break the non-blocking one.
     # Unfortunately, there is no one-off MSG_DONTWAIT-like flag for
     # accept4(2).
-    inherited = ENV['YAHNS_FD'].to_s.split(',').map! do |fd|
-      io = Socket.for_fd(fd.to_i)
+    inherited = ENV['YAHNS_FD'].to_s.split(',')
+
+    # emulate sd_listen_fds() for systemd
+    sd_pid, sd_fds = ENV.values_at('LISTEN_PID', 'LISTEN_FDS')
+    if sd_pid && sd_pid.to_i == $$
+      # 3 = SD_LISTEN_FDS_START
+      inherited.concat((3...(3 + sd_fds.to_i)).map { |fd| Socket.for_fd(fd) })
+    end
+    # to ease debugging, we will not unset LISTEN_PID and LISTEN_FDS
+
+    inherited.map! do |fd|
+      io = String === fd ? Socket.for_fd(fd.to_i) : fd
       opts = sock_opts(io)
+      io = server_cast(io, opts)
       set_server_sockopt(io, opts)
-      @logger.info "inherited addr=#{sock_name(io)} fd=#{fd}"
-      server_cast(io, opts)
+      @logger.info "inherited addr=#{sock_name(io)} fd=#{io.fileno}"
+      io
     end
 
     @listeners.replace(inherited)

data/lib/yahns/version.rb

@@ -1 +1 @@
-Yahns::VERSION = '1.8.0' # :nodoc:
+Yahns::VERSION = '1.9.0' # :nodoc:

data/test/helper.rb

@@ -140,7 +140,7 @@ class DieIfUsed
   end
 
   def close
-    warn "INFO #$$ closed DieIfUsed #{@@n += 1}"
+    warn "INFO #$$ closed DieIfUsed #{@@n += 1}\n"
   end
 end
 

data/test/test_bin.rb

@@ -11,6 +11,40 @@ class TestBin < Testcase
     @cmd = %W(ruby -I lib bin/yahns)
   end
 
+  def test_listen_fd3
+    return unless RUBY_VERSION.to_f > 2.3 # Fixed in ruby/trunk r51209, actually
+    @srv.setsockopt(:SOL_SOCKET, :SO_KEEPALIVE, 0)
+    host, port = @srv.addr[3], @srv.addr[1]
+
+    ru = tmpfile(%w(test_bin_daemon .ru))
+    ru.write("require 'rack/lobster'; run Rack::Lobster.new\n")
+    cmd = %W(ruby -I lib bin/yahns-rackup
+             -E none -p #{port} -o #{host} #{ru.path})
+    pid = fork do # emulate a systemd environment
+      env = {
+        'LISTEN_PID' => $$.to_s,
+        'LISTEN_FDS' => '1',
+      }
+      exec env, *cmd, 3 => @srv, err: @err.path
+    end
+    Net::HTTP.start(host, port) do |http|
+      req = Net::HTTP::Get.new("/")
+      res = http.request(req)
+      assert_equal 200, res.code.to_i
+      assert_equal "keep-alive", res["Connection"]
+    end
+
+    assert_equal 1, @srv.getsockopt(:SOL_SOCKET, :SO_KEEPALIVE).int,
+                 'ensure the inheriting process applies TCP socket options'
+  ensure
+    if pid
+      Process.kill(:QUIT, pid)
+      _, status = Process.waitpid2(pid)
+      assert status.success?, status.inspect
+    end
+    ru.close! if ru
+  end
+
   def test_bin_daemon_noworker_inherit
     bin_daemon(false, true)
   end

data/test/test_rack_hijack.rb

@@ -52,16 +52,28 @@ class TestRackHijack < Testcase
     end
     pid = mkserver(cfg)
     res = Net::HTTP.start(host, port) { |h| h.get("/hijack_req") }
+
+    wait_for_msg = lambda do |n|
+      tries = 10000
+      begin
+        Thread.new { Thread.pass }.join # calls sched_yield() on MRI
+      end until File.readlines(err.path).grep(/DieIfUsed/).size >= n ||
+                (tries -= 1) < 0
+    end
     assert_equal "request.hijacked", res.body
     assert_equal 200, res.code.to_i
     assert_equal "1.0", res.http_version
 
+    wait_for_msg.call(1)
+
     res = Net::HTTP.start(host, port) { |h| h.get("/hijack_res") }
     assert_equal "response.hijacked", res.body
     assert_equal 200, res.code.to_i
     assert_equal "zzz", res["X-Test"]
     assert_equal "1.1", res.http_version
 
+    wait_for_msg.call(2)
+
     errs = File.readlines(err.path).grep(/DieIfUsed/)
     assert_equal([ "INFO #{pid} closed DieIfUsed 1\n",
                    "INFO #{pid} closed DieIfUsed 2\n" ], errs)

data/test/test_server.rb

@@ -845,4 +845,24 @@ class TestServer < Testcase
   ensure
     quit_wait(pid)
   end
+
+  def test_inherit_tcp_nodelay_set
+    err = @err
+    cfg = Yahns::Config.new
+    host, port = @srv.addr[3], @srv.addr[1]
+    @srv.setsockopt(:IPPROTO_TCP, :TCP_NODELAY, 0)
+    assert_equal 0, @srv.getsockopt(:IPPROTO_TCP, :TCP_NODELAY).int
+    cfg.instance_eval do
+      ru = lambda { |_| [ 200, { 'Content-Length' => '2' } , [ 'HI' ] ] }
+      GTL.synchronize { app(:rack, ru) { listen "#{host}:#{port}" } }
+      logger(Logger.new(err.path))
+    end
+    pid = mkserver(cfg, @srv) { ENV["YAHNS_FD"] = "#{@srv.fileno}" }
+    run_client(host, port) { |res| assert_equal "HI", res.body }
+
+    # TCP socket option is shared at file level, not FD level:
+    assert_equal 1, @srv.getsockopt(:IPPROTO_TCP, :TCP_NODELAY).int
+  ensure
+    quit_wait(pid)
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yahns
 version: !ruby/object:Gem::Version
-  version: 1.8.0
+  version: 1.9.0
 platform: ruby
 authors:
 - yahns hackers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-11 00:00:00.000000000 Z
+date: 2015-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kgio
@@ -220,7 +220,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.5.0
 signing_key: 
 specification_version: 4
 summary: sleepy, multi-threaded, non-blocking application server