pitchfork 0.11.1 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5dc129b2e6e6e940be0f9e388400a376614a65a125a64b68c73b919744c433b3
-  data.tar.gz: b12e1d5f360edc7159567060c095b40510e8e89c54dae058882742c29c830f78
+  metadata.gz: cd251198665823484f036ddf2cf11c9415c3c07c04c8e6e809c0e74b05c1055f
+  data.tar.gz: fc9475e4c4605b8bdf6cb7854946577413bbe980b5ac531a1638b43be4574d03
 SHA512:
-  metadata.gz: 4a43b0204dc0e77a4d28007dbfd89e9645724a4198ea6ec7ffa0895aefaf075bd42d4303c37d0f7e61afb550b665b78ab6b22ca9f934ef2d3721883acf0a68cd
-  data.tar.gz: 7eb41807d6971ac948ee264b1f70fd2e16afcf8f289655073c876b752a53a405b9705e97509f5be82c519ee12694ecf1910b18a20cce8aad3ce9a4ffd3af9ac6
+  metadata.gz: ba08c99f11e707e37af4265ac9f1dd7f15c62243b2c65ffc6dd2a3189db51dc3512f5b59234b16c98aff396fc88585d0f2c255ab7af9921653c9fdb4efbe7e61
+  data.tar.gz: '06790f57c21601cc73bcf34a01d89278c5bf6fb34b846a0534ab5d6982432c334ee101d50154a465e503fb92378c0e2809a5b94704e129aa4ee0cbfb5e88f058'

data/.github/workflows/ci.yml

@@ -14,7 +14,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Check out code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
@@ -25,5 +25,5 @@ jobs:
       - name: Install packages
         run: sudo apt-get install -y ragel socat netcat
 
-      - name: Tests
+      - name: Tests ${{ matrix.rubyopt }}
         run: bundle exec rake

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Unreleased
 
+# 0.13.0
+
+- Fix compatibility with `--enable-frozen-string-literal` in preparation for Ruby 3.4.
+- Extend timed out workers deadline after sending signals to avoid flooding.
+- Fix compilation with Ruby 2.7 and older on macOS.
+
+# 0.12.0
+
+- Disable IO tracking on Rubies older than 3.2.3 to avoid running into https://bugs.ruby-lang.org/issues/19531.
+  This Ruby bug can lead to memory corruption that cause VM crashes when calling various IO methods.
+- Implement `rack.response_finished` (#97).
+- Don't break the `rack.after_reply` callback chain if one callback raises (#97).
+
 # 0.11.1
 
 - Fix Ruby 3.4-dev compatibility.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pitchfork (0.11.1)
+    pitchfork (0.13.0)
       rack (>= 2.0)
       raindrops (~> 0.7)
 
@@ -12,7 +12,7 @@ GEM
     nio4r (2.7.0)
     puma (6.4.2)
       nio4r (~> 2.0)
-    rack (3.0.9.1)
+    rack (3.0.10)
     raindrops (0.20.1)
     rake (13.0.6)
     rake-compiler (1.2.1)
@@ -31,4 +31,4 @@ DEPENDENCIES
   rake-compiler
 
 BUNDLED WITH
-   2.3.22
+   2.3.27

data/benchmark/README.md

@@ -2,7 +2,7 @@
 
 ## Copy on Write Efficiency
 
-This benchmark aimed to compare real memory usage of differnet servers.
+This benchmark aimed to compare real memory usage of different servers.
 
 For instance, Puma 2 workers + 2 threads:
 

data/benchmark/cow_benchmark.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 require "net/http"
 
 app_path = File.expand_path('../examples/constant_caches.ru', __dir__)

data/docs/CONFIGURATION.md

@@ -188,7 +188,7 @@ The second "hard" timeout, is the sum of `timeout` and `cleanup`.
 Workers taking longer than this time period to be ready to handle a new
 request will be forcibly killed (via `SIGKILL`).
 
-Neither of these timeout mecanisms should be routinely relied on, and should
+Neither of these timeout mechanisms should be routinely relied on, and should
 instead be considered as a last line of defense in case you application
 is impacted by bugs causing unexpectedly slow response time, or fully stuck
 processes.

data/examples/constant_caches.ru

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require_relative "../lib/pitchfork/mem_info"
 
 module App

data/examples/echo.ru

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # Example application that echoes read data back to the HTTP client.
 # This emulates the old echo protocol people used to run.
 #

data/examples/hello.ru

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 run lambda { |env|
   /\A100-continue\z/i =~ env['HTTP_EXPECT'] and return [100, {}, []]
   body = "Hello World!\n"

data/examples/pitchfork.conf.minimal.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # Minimal sample configuration file for Pitchfork
 
 # listen 2007 # by default Pitchfork listens on port 8080

data/examples/pitchfork.conf.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # Sample verbose configuration file for Pitchfork
 
 # Use at least one worker per core if you're on a dedicated server,

data/exe/pitchfork

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 # -*- encoding: binary -*-
 require 'pitchfork/launcher'
 require 'optparse'

data/ext/pitchfork_http/epollexclusive.h

@@ -11,10 +11,11 @@
 #if defined(HAVE_EPOLL_CREATE1)
 #  include <sys/epoll.h>
 #  include <errno.h>
-#  include <ruby/io.h>
 #  include <ruby/thread.h>
 #endif /* __linux__ */
 
+#include <ruby/io.h>
+
 #if defined(EPOLLEXCLUSIVE) && defined(HAVE_EPOLL_CREATE1)
 #  define USE_EPOLL (1)
 #else
@@ -50,7 +51,6 @@ static VALUE prep_readers(VALUE cls, VALUE readers)
 	for (i = 0; i < RARRAY_LEN(readers); i++) {
 		int rc;
 		struct epoll_event e;
-		rb_io_t *fptr;
 		VALUE io = rb_ary_entry(readers, i);
 
 		e.data.u64 = i; /* the reason readers shouldn't change */

data/ext/pitchfork_http/extconf.rb

@@ -1,4 +1,5 @@
 # -*- encoding: binary -*-
+# frozen_string_literal: true
 require 'mkmf'
 
 have_const("PR_SET_CHILD_SUBREAPER", "sys/prctl.h")

data/lib/pitchfork/app/old_rails/static.rb

@@ -1,4 +1,5 @@
 # -*- encoding: binary -*-
+# frozen_string_literal: true
 # :enddoc:
 # This code is based on the original Rails handler in Mongrel
 # Copyright (c) 2005 Zed A. Shaw

data/lib/pitchfork/children.rb

@@ -1,4 +1,5 @@
 # -*- encoding: binary -*-
+# frozen_string_literal: true
 
 module Pitchfork
   # This class keep tracks of the state of all the master children.

data/lib/pitchfork/configurator.rb

@@ -1,4 +1,5 @@
 # -*- encoding: binary -*-
+# frozen_string_literal: true
 require 'logger'
 
 module Pitchfork

data/lib/pitchfork/const.rb

@@ -1,4 +1,5 @@
 # -*- encoding: binary -*-
+# frozen_string_literal: true
 
 module Pitchfork
   module Const # :nodoc:

data/lib/pitchfork/flock.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'tempfile'
 
 module Pitchfork

data/lib/pitchfork/http_parser.rb

@@ -1,4 +1,5 @@
 # -*- encoding: binary -*-
+# frozen_string_literal: true
 # :enddoc:
 # no stable API here
 
@@ -19,10 +20,10 @@ module Pitchfork
       "SERVER_SOFTWARE" => "Pitchfork #{Pitchfork::Const::UNICORN_VERSION}"
     }
 
-    NULL_IO = StringIO.new("")
+    NULL_IO = StringIO.new.binmode
 
     # :stopdoc:
-    HTTP_RESPONSE_START = [ 'HTTP'.freeze, '/1.1 '.freeze ]
+    HTTP_RESPONSE_START = [ 'HTTP', '/1.1 ' ]
     EMPTY_ARRAY = [].freeze
     @@input_class = Pitchfork::TeeInput
     @@check_client_connection = false
@@ -104,7 +105,7 @@ module Pitchfork
     end
 
     def hijacked?
-      env.include?('rack.hijack_io'.freeze)
+      env.include?('rack.hijack_io')
     end
 
     if Raindrops.const_defined?(:TCP_Info)
@@ -199,11 +200,11 @@ module Pitchfork
         val.downcase!
       end
 
-      if vals.pop == 'chunked'.freeze
-        return true unless vals.include?('chunked'.freeze)
+      if vals.pop == 'chunked'
+        return true unless vals.include?('chunked')
         raise Pitchfork::HttpParserError, 'double chunked', []
       end
-      return false unless vals.include?('chunked'.freeze)
+      return false unless vals.include?('chunked')
       raise Pitchfork::HttpParserError, 'chunked not last', []
     end
   end

data/lib/pitchfork/http_response.rb

@@ -1,4 +1,5 @@
 # -*- encoding: binary -*-
+# frozen_string_literal: true
 # :enddoc:
 
 module Pitchfork
@@ -48,10 +49,10 @@ module Pitchfork
       if headers
         code = status.to_i
         msg = STATUS_CODES[code]
-        start = req.response_start_sent ? ''.freeze : 'HTTP/1.1 '.freeze
+        start = req.response_start_sent ? '' : 'HTTP/1.1 '
         buf = "#{start}#{msg ? %Q(#{code} #{msg}) : status}\r\n" \
               "Date: #{httpdate}\r\n" \
-              "Connection: close\r\n"
+              "Connection: close\r\n".b
         headers.each do |key, value|
           case key
           when %r{\A(?:Date|Connection)\z}i

data/lib/pitchfork/http_server.rb

@@ -1,4 +1,6 @@
 # -*- encoding: binary -*-
+# frozen_string_literal: true
+
 require 'pitchfork/pitchfork_http'
 require 'pitchfork/flock'
 require 'pitchfork/soft_timeout'
@@ -91,7 +93,7 @@ module Pitchfork
     # in new projects
     LISTENERS = []
 
-    NOOP = '.'.freeze
+    NOOP = '.'
 
     # :startdoc:
     # This Hash is considered a stable interface and changing its contents
@@ -512,6 +514,7 @@ module Pitchfork
           next
         else # worker is out of time
           next_sleep = 0
+          child.deadline = now + 1
           hard_timeout(child)
         end
       end
@@ -696,7 +699,7 @@ module Pitchfork
 
     def e103_response_write(client, headers)
       rss = @request.response_start_sent
-      buf = rss ? "103 Early Hints\r\n" : "HTTP/1.1 103 Early Hints\r\n"
+      buf = (rss ? "103 Early Hints\r\n" : "HTTP/1.1 103 Early Hints\r\n").b
       headers.each { |key, value| append_header(buf, key, value) }
       buf << (rss ? "\r\nHTTP/1.1 ".freeze : "\r\n".freeze)
       client.write(buf)
@@ -710,7 +713,7 @@ module Pitchfork
       client.write(@request.response_start_sent ?
                    "100 Continue\r\n\r\nHTTP/1.1 ".freeze :
                    "HTTP/1.1 100 Continue\r\n\r\n".freeze)
-      env.delete('HTTP_EXPECT'.freeze)
+      env.delete('HTTP_EXPECT')
     end
 
     # once a client is accepted, it is processed in its entirety here
@@ -732,7 +735,7 @@ module Pitchfork
         end
       end
 
-      env["rack.after_reply"] = []
+      env["rack.response_finished"] = env["rack.after_reply"] = []
 
       status, headers, body = @app.call(env)
 
@@ -758,11 +761,21 @@ module Pitchfork
         client.close # flush and uncork socket immediately, no keepalive
       end
       env
-    rescue => e
-      handle_error(client, e)
+    rescue => application_error
+      handle_error(client, application_error)
       env
     ensure
-      env["rack.after_reply"].each(&:call) if env
+      if env
+        env["rack.response_finished"].each do |callback|
+          if callback.arity == 0
+            callback.call
+          else
+            callback.call(env, status, headers, application_error)
+          end
+        rescue => callback_error
+          Pitchfork.log_error(@logger, "rack.after_reply error", callback_error)
+        end
+      end
       timeout_handler.finished
       env
     end

data/lib/pitchfork/info.rb

@@ -4,9 +4,6 @@ require 'pitchfork/shared_memory'
 
 module Pitchfork
   module Info
-    @workers_count = 0
-    @fork_safe = true
-
     class WeakSet # :nodoc
       def initialize
         @map = ObjectSpace::WeakMap.new
@@ -27,42 +24,68 @@ module Pitchfork
       end
     end
 
-    @kept_ios = WeakSet.new
+    if RUBY_VERSION < "3.2.3" && RUBY_ENGINE == "ruby"
+      class << self
+        def keep_io(io)
+          io # noop
+        end
 
-    class << self
-      attr_accessor :workers_count
+        def keep_ios(ios)
+          ios # noop
+        end
 
-      def keep_io(io)
-        raise ArgumentError, "#{io.inspect} doesn't respond to :to_io" unless io.respond_to?(:to_io)
-        @kept_ios << io
-        io
-      end
+        def close_all_ios!
+          raise NoMethodError, <<~MSG
+            Your Ruby version is subject to a bug that prevent `.close_all_ios!` from working.
+            See: https://bugs.ruby-lang.org/issues/19531.
 
-      def keep_ios(ios)
-        ios.each { |io| keep_io(io) }
+            Consider upgrading to Ruby 3.2.3+
+          MSG
+        end
       end
+    else
+      @kept_ios = WeakSet.new
+
+      class << self
+        def keep_io(io)
+          raise ArgumentError, "#{io.inspect} doesn't respond to :to_io" unless io.respond_to?(:to_io)
+          @kept_ios << io
+          io
+        end
 
-      def close_all_ios!
-        ignored_ios = [$stdin, $stdout, $stderr, STDIN, STDOUT, STDERR].uniq.compact
-
-        @kept_ios.each do |io_like|
-          ignored_ios << (io_like.is_a?(IO) ? io_like : io_like.to_io)
+        def keep_ios(ios)
+          ios.each { |io| keep_io(io) }
         end
 
-        ObjectSpace.each_object(IO) do |io|
-          if io_open?(io) && io_autoclosed?(io) && !ignored_ios.include?(io)
-            if io.is_a?(TCPSocket)
-              # If we inherited a TCP Socket, calling #close directly could send FIN or RST.
-              # So we first reopen /dev/null to avoid that.
-              io.reopen(File::NULL)
-            end
-            begin
-              io.close
-            rescue Errno::EBADF
+        def close_all_ios!
+          ignored_ios = [$stdin, $stdout, $stderr, STDIN, STDOUT, STDERR].uniq.compact
+
+          @kept_ios.each do |io_like|
+            ignored_ios << (io_like.is_a?(IO) ? io_like : io_like.to_io)
+          end
+
+          ObjectSpace.each_object(IO) do |io|
+            if io_open?(io) && io_autoclosed?(io) && !ignored_ios.include?(io)
+              if io.is_a?(TCPSocket)
+                # If we inherited a TCP Socket, calling #close directly could send FIN or RST.
+                # So we first reopen /dev/null to avoid that.
+                io.reopen(File::NULL)
+              end
+              begin
+                io.close
+              rescue Errno::EBADF
+              end
             end
           end
         end
       end
+    end
+
+    @workers_count = 0
+    @fork_safe = true
+
+    class << self
+      attr_accessor :workers_count
 
       def fork_safe?
         @fork_safe

data/lib/pitchfork/launcher.rb

@@ -1,4 +1,5 @@
 # -*- encoding: binary -*-
+# frozen_string_literal: true
 
 # :enddoc:
 $stdout.sync = $stderr.sync = true

data/lib/pitchfork/message.rb

@@ -1,4 +1,5 @@
 # -*- encoding: binary -*-
+# frozen_string_literal: true
 
 # :stopdoc:
 module Pitchfork
@@ -14,6 +15,7 @@ module Pitchfork
     FD = Struct.new(:index)
 
     def initialize(socket)
+      raise ArgumentError, "expected a socket, got: #{socket.inspect}" unless socket
       @socket = socket
     end
 

data/lib/pitchfork/select_waiter.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Pitchfork
   # fallback for non-Linux and Linux <4.5 systems w/o EPOLLEXCLUSIVE
   class SelectWaiter # :nodoc:

data/lib/pitchfork/socket_helper.rb

@@ -1,4 +1,5 @@
 # -*- encoding: binary -*-
+# frozen_string_literal: true
 # :enddoc:
 require 'socket'
 

data/lib/pitchfork/stream_input.rb

@@ -1,4 +1,5 @@
 # -*- encoding: binary -*-
+# frozen_string_literal: true
 
 module Pitchfork
   # When processing uploads, pitchfork may expose a StreamInput object under
@@ -17,7 +18,7 @@ module Pitchfork
       @socket = socket
       @parser = request
       @buf = request.buf
-      @rbuf = ''
+      @rbuf = +''
       @bytes_read = 0
       filter_body(@rbuf, @buf) unless @buf.empty?
     end
@@ -41,7 +42,7 @@ module Pitchfork
     # ios.read(length [, buffer]) will return immediately if there is
     # any data and only block when nothing is available (providing
     # IO#readpartial semantics).
-    def read(length = nil, rv = '')
+    def read(length = nil, rv = ''.b)
       if length
         if length <= @rbuf.size
           length < 0 and raise ArgumentError, "negative length #{length} given"
@@ -79,16 +80,16 @@ module Pitchfork
     # unlike IO#gets.
     def gets(sep = $/)
       if sep.nil?
-        read_all(rv = '')
+        read_all(rv = ''.b)
         return rv.empty? ? nil : rv
       end
       re = /\A(.*?#{Regexp.escape(sep)})/
 
       begin
-        @rbuf.sub!(re, '') and return $1
+        @rbuf.sub!(re, ''.b) and return $1
         return @rbuf.empty? ? nil : @rbuf.slice!(0, @rbuf.size) if eof?
         @socket.readpartial(@@io_chunk_size, @buf) or eof!
-        filter_body(once = '', @buf)
+        filter_body(once = ''.b, @buf)
         @rbuf << once
       end while true
     end

data/lib/pitchfork/tee_input.rb

@@ -1,4 +1,5 @@
 # -*- encoding: binary -*-
+# frozen_string_literal: true
 
 module Pitchfork
   # Acts like tee(1) on an input input to provide a input-like stream
@@ -42,7 +43,7 @@ module Pitchfork
       @len = request.content_length
       super
       @tmp = @len && @len <= @@client_body_buffer_size ?
-             StringIO.new("") : new_tmpio
+             StringIO.new.binmode : new_tmpio
     end
 
     # :call-seq:
@@ -121,7 +122,7 @@ module Pitchfork
 
     # consumes the stream of the socket
     def consume!
-      junk = ""
+      junk = "".b
       nil while read(@@io_chunk_size, junk)
     end
 

data/lib/pitchfork/tmpio.rb

@@ -1,4 +1,5 @@
 # -*- encoding: binary -*-
+# frozen_string_literal: true
 # :stopdoc:
 require 'tmpdir'
 

data/lib/pitchfork/version.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Pitchfork
-  VERSION = "0.11.1"
+  VERSION = "0.13.0"
   module Const
     UNICORN_VERSION = '6.1.0'
   end

data/lib/pitchfork/worker.rb

@@ -1,4 +1,5 @@
 # -*- encoding: binary -*-
+# frozen_string_literal: true
 require 'pitchfork/shared_memory'
 
 module Pitchfork

data/lib/pitchfork.rb

@@ -1,4 +1,5 @@
 # -*- encoding: binary -*-
+# frozen_string_literal: true
 require 'etc'
 require 'stringio'
 require 'raindrops'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pitchfork
 version: !ruby/object:Gem::Version
-  version: 0.11.1
+  version: 0.13.0
 platform: ruby
 authors:
 - Jean Boussier
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-03-06 00:00:00.000000000 Z
+date: 2024-04-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: raindrops