pitchfork 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 990697289cbe2c021f74571daada6e866a7ad796df6c855be4852d106ad84b7d
-  data.tar.gz: a8dd04579e7f955075ee96c95ff003f82de2897ba9f96839ddb05c7e701f45ce
+  metadata.gz: 7e837b05925916feb0b10fb28b2ddfbc8bb476aa77091217cbb012fd0c98f6c0
+  data.tar.gz: 5b89fafb322999c204408a642e39547a652b61968bd2eae4b1c87b77ae51baec
 SHA512:
-  metadata.gz: 746fa1aaff6dd152e5d1b210088f1cdf2e3388d841fd302347919a470afd09e8a0188099a89280e6368d0dff8afe62c884140d332fa45dfdd3bed23b57d386df
-  data.tar.gz: 6586706a8d2c5eb31fae62a822f5f7c405356ddab44c8f2add1ff3e994715ac724be0c666cc26d38acec5922ce10c3967c03c2d9a9580447ba3a8198e5d0667f
+  metadata.gz: df56d4c6bb70b5735e4859c1186b3e754210b84dfd457f804d6f93f2ac804205f351bd2ef557a09f05fa39896bb29180c6974ef9c74a062c8ddbb32506bc5c36
+  data.tar.gz: 93791c5474ec82f7470270f371df480ff7178ab903ee59799ddd975d0154841234895bce720c911b0fafba78016f36cc7fbac7210b7025417bff5fde898da0b8

data/CHANGELOG.md

@@ -0,0 +1,13 @@
+# Unreleased
+
+# 0.1.2
+
+- Improve Ruby 3.2 and Rack 3 compatibility.
+
+# 0.1.1
+
+- Fix `extconf.rb` to move the extension in the right place on gem install. (#18)
+
+# 0.1.0
+
+Initial release

data/Gemfile

@@ -6,4 +6,8 @@ gem 'minitest'
 gem 'rake'
 gem 'rake-compiler'
 
+group :benchmark do
+  gem "puma"
+end
+
 gemspec

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pitchfork (0.1.0)
+    pitchfork (0.1.2)
       rack (>= 2.0)
       raindrops (~> 0.7)
 
@@ -9,7 +9,10 @@ GEM
   remote: https://rubygems.org/
   specs:
     minitest (5.16.3)
-    rack (3.0.0)
+    nio4r (2.5.8)
+    puma (5.6.5)
+      nio4r (~> 2.0)
+    rack (3.0.4.1)
     raindrops (0.20.0)
     rake (13.0.6)
     rake-compiler (1.2.0)
@@ -23,6 +26,7 @@ PLATFORMS
 DEPENDENCIES
   minitest
   pitchfork!
+  puma
   rake
   rake-compiler
 

data/LICENSE

@@ -1,11 +1,10 @@
-Unicorn is copyrighted free software by all contributors, see logs in
+Pitchfork is copyrighted free software by all contributors, see logs in
 revision control for names and email addresses of all of them.
 
 You can redistribute it and/or modify it under either the terms of the
 GNU General Public License (GPL) as published by the Free Software
 Foundation (FSF), either version 2 of the License, or (at your option)
-any later version.  We currently prefer the GPLv3 or later for
-derivative works, but the GPLv2 is fine.
+any later version.
 
 The complete texts of the GPLv2 and GPLv3 are below:
 GPLv2 - https://www.gnu.org/licenses/gpl-2.0.txt

data/README.md

@@ -3,7 +3,7 @@
 `pitchfork` is a preforking HTTP server for Rack applications designed
 to minimize memory usage by maximizing Copy-on-Write performance.
 
-Like [`unicorn`](https://yhbt.net/unicorn/README.html) (which `pitchfork` is a derivative of), is it designed to
+Like [`unicorn`](https://yhbt.net/unicorn/README.html) (of which `pitchfork` is a derivative), it is designed to
 only serve fast clients on low-latency, high-bandwidth connections and take
 advantage of features in Unix/Unix-like kernels. Slow clients should
 only be served by placing a reverse proxy capable of fully buffering
@@ -99,6 +99,16 @@ compatibility with existing applications.
 Most command-line options for other Rack applications (above) are also
 supported.  Run `pitchfork -h` to see command-line options.
 
+## Relation to Unicorn
+
+Pitchfork initially started as a Unicorn patch, however some of Unicorn features
+as well as Unicorn policy of supporting extremely old Ruby version made it challenging.
+
+Forking was the occasion to significantly reduce the complexity.
+
+However some large parts of Pitchfork like the HTTP parser are still mostly unchanged from Unicorn, and Unicorn
+is fairly stable these days. As such we aim to backport any Unicorn patches that may apply to Pitchfork and vice versa.
+
 ## License
 
 pitchfork is copyright 2022 Shopify Inc and all contributors.
@@ -108,8 +118,7 @@ Unicorn is copyright 2009-2018 by all contributors (see logs in git).
 It is based on Mongrel 1.1.5.
 Mongrel is copyright 2007 Zed A. Shaw and contributors.
 
-pitchfork is licensed under (your choice) of the GPLv2 or later
-(GPLv3+ preferred), or Ruby (1.8)-specific terms.
+pitchfork is licensed under the GPLv2 or later or Ruby (1.8)-specific terms.
 See the included LICENSE file for details.
 
 ## Thanks

data/benchmark/README.md

@@ -0,0 +1,32 @@
+# Benchmarks
+
+## Copy on Write Efficiency
+
+This benchmark aimed to compare real memory usage of differnet servers.
+
+For instance, Puma 2 workers + 2 threads:
+
+```bash
+$ PORT=9292 bundle exec benchmark/cow_benchmark.rb puma -w 2 -t 2 --preload
+Booting server...
+Warming the app with ab...
+Memory Usage:
+Single Worker Memory Usage: 207.5 MiB
+Total Cluster Memory Usage: 601.6 MiB
+```
+
+Pitchfork 4 workers:
+
+```bash
+$ PORT=8080 bundle exec benchmark/cow_benchmark.rb pitchfork -c examples/pitchfork.conf.minimal.rb 
+Booting server...
+Warming the app with ab...
+Memory Usage:
+Single Worker Memory Usage: 62.6 MiB
+Total Cluster Memory Usage: 320.3 MiB
+```
+
+The `constant_caches.ru` application is specifically crafted to demonstrate how shared memory regions
+get invalidated as applications execute more and more code.
+
+It is an extreme example for benchmark purposes.

data/benchmark/cow_benchmark.rb

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+require "net/http"
+
+app_path = File.expand_path('../examples/constant_caches.ru', __dir__)
+
+puts "Booting server..."
+pid = Process.spawn(*ARGV, app_path, out: File::NULL, err: File::NULL)
+sleep 5
+app_url = "http://localhost:#{ENV.fetch('PORT')}/"
+puts "Warming the app with ab..."
+system("ab", "-c", "4", "-n", "500", app_url, out: File::NULL, err: File::NULL)
+sleep 3
+puts "Memory Usage:"
+puts Net::HTTP.get(URI(app_url))
+
+Process.kill("TERM", pid)
+Process.wait

data/examples/constant_caches.ru

@@ -1,4 +1,4 @@
-require "pitchfork/mem_info"
+require_relative "../lib/pitchfork/mem_info"
 
 module App
   CONST_NUM = Integer(ENV.fetch("NUM", 100_000))

data/examples/pitchfork.conf.minimal.rb

@@ -1,5 +1,5 @@
 # Minimal sample configuration file for Pitchfork
 
-listen 2007 # by default Pitchfork listens on port 8080
+# listen 2007 # by default Pitchfork listens on port 8080
 worker_processes 4 # this should be >= nr_cpus
 refork_after [50, 100, 1000]

data/ext/pitchfork_http/extconf.rb

@@ -11,4 +11,4 @@ else
 end
 
 have_func('epoll_create1', %w(sys/epoll.h))
-create_makefile("pitchfork_http")
+create_makefile("pitchfork/pitchfork_http")

data/lib/pitchfork/http_response.rb

@@ -20,6 +20,18 @@ module Pitchfork
         "#{code} #{STATUS_CODES[code]}\r\n\r\n"
     end
 
+    def append_header(buf, key, value)
+      case value
+      when Array # Rack 3
+        value.each { |v| buf << "#{key}: #{v}\r\n" }
+      when /\n/ # Rack 2
+        # avoiding blank, key-only cookies with /\n+/
+        value.split(/\n+/).each { |v| buf << "#{key}: #{v}\r\n" }
+      else
+        buf << "#{key}: #{value}\r\n"
+      end
+    end
+
     # writes the rack_response to socket as an HTTP response
     def http_response_write(socket, status, headers, body,
                             req = Pitchfork::HttpParser.new)
@@ -41,12 +53,7 @@ module Pitchfork
             # key in Rack < 1.5
             hijack = value
           else
-            if value =~ /\n/
-              # avoiding blank, key-only cookies with /\n+/
-              value.split(/\n+/).each { |v| buf << "#{key}: #{v}\r\n" }
-            else
-              buf << "#{key}: #{value}\r\n"
-            end
+            append_header(buf, key, value)
           end
         end
         socket.write(buf << "\r\n".freeze)

data/lib/pitchfork/http_server.rb

@@ -572,22 +572,11 @@ module Pitchfork
     end
 
     def e103_response_write(client, headers)
-      response = if @request.response_start_sent
-        "103 Early Hints\r\n"
-      else
-        "HTTP/1.1 103 Early Hints\r\n"
-      end
-
-      headers.each_pair do |k, vs|
-        next if !vs || vs.empty?
-        values = vs.to_s.split("\n".freeze)
-        values.each do |v|
-          response << "#{k}: #{v}\r\n"
-        end
-      end
-      response << "\r\n".freeze
-      response << "HTTP/1.1 ".freeze if @request.response_start_sent
-      client.write(response)
+      rss = @request.response_start_sent
+      buf = rss ? "103 Early Hints\r\n" : "HTTP/1.1 103 Early Hints\r\n"
+      headers.each { |key, value| append_header(buf, key, value) }
+      buf << (rss ? "\r\nHTTP/1.1 ".freeze : "\r\n".freeze)
+      client.write(buf)
     end
 
     def e100_response_write(client, env)

data/lib/pitchfork/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pitchfork
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Jean Boussier
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-10-05 00:00:00.000000000 Z
+date: 2023-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: raindrops
@@ -53,6 +53,7 @@ files:
 - ".gitattributes"
 - ".github/workflows/ci.yml"
 - ".gitignore"
+- CHANGELOG.md
 - COPYING
 - Dockerfile
 - Gemfile
@@ -60,6 +61,8 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- benchmark/README.md
+- benchmark/cow_benchmark.rb
 - docs/Application_Timeouts.md
 - docs/CONFIGURATION.md
 - docs/DESIGN.md