pitchfork 0.14.0 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9d3eb42c934de40ea4ae4e25e5d334af536a03f9818dfec8798319744d1629a5
-  data.tar.gz: 5ea480e75dabff8298cb419a9ca1ba159af04985f4e02df8fcb51c6eff65b996
+  metadata.gz: a36b331190b5554261852d4a7da0f2e074723cdd1d7ad33a2274a0a532f7ea46
+  data.tar.gz: bb8ade8d07f6669d1f1e1d55500951d7a27057bf03aa7043caa55dfd8813728b
 SHA512:
-  metadata.gz: c934f51445bc2b2904f9ecb84edfb0d454e87494fdb3a58210bf5e9b3e69887a6817be1d38f217696432ab40006448f97d22aa0eca866be4e09c6e80ca0499db
-  data.tar.gz: c2dfdf19c3a08aa91199b6289fef08add17281d60eaa3eefd361fb1de74aae0083ae2f10123293782d92b3c8a152b00c21676143c21b03487fecef2c8994d982
+  metadata.gz: 3ef8b8ef5217c5b4cc6a63313151ef2d5c1cb823e25caa99f851def3a24e2ad62527db30c06102acea7cdf0638f9627668b931135a093d31ea99fe30c5ae141c
+  data.tar.gz: 5b92506d1725596b4fb772dd4d0ebe850daf574787d94573083bf0dc3e3e245d5cbde07c7bc7fb85ceb936e33c01c9a71b44aa25c8752b7c4ca325af80ab1957

data/.github/workflows/ci.yml

@@ -4,7 +4,7 @@ on: [push, pull_request]
 
 jobs:
   ruby:
-    name: Ruby ${{ matrix.ruby }} ${{ matrix.rubyopt }}
+    name: Ruby ${{ matrix.ruby }} / Rack ${{ matrix.rack }} ${{ matrix.rubyopt }}
     timeout-minutes: 15
     strategy:
       fail-fast: false
@@ -12,15 +12,24 @@ jobs:
         os: ["ubuntu-latest"]
         ruby: ["ruby-head", "3.3", "3.2", "3.1", "3.0", "2.7", "2.6"]
         rubyopt: [""]
+        rack: ["~> 3.1"]
         include:
           - ruby: "3.3"
             rubyopt: "--enable-frozen-string-literal"
+            rack: "~> 3.1"
+          - ruby: "3.3"
+            rack: "~> 3.0.0"
+          - ruby: "3.3"
+            rack: "~> 2.0"
+    env:
+      RACK_VERSION: "${{ matrix.rack }}"
+      RUBYOPT: "${{ matrix.rubyopt }}"
     runs-on: ubuntu-latest
     steps:
       - name: Check out code
         uses: actions/checkout@v4
 
-      - name: Set up Ruby
+      - name: Set up Ruby ${{ matrix.ruby }}
         uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
@@ -29,5 +38,8 @@ jobs:
       - name: Install packages
         run: sudo apt-get install -y ragel socat netcat
 
-      - name: Tests ${{ matrix.rubyopt }}
-        run: RUBYOPT="${{ matrix.rubyopt }}" bundle exec rake
+      - name: Tests Rack ${{ matrix.rack }} ${{ matrix.rubyopt }}
+        run: bundle exec rake
+
+      - name: Ensure ragel output is up-to-date
+        run: git diff --exit-code

data/.gitignore

@@ -22,3 +22,4 @@ pkg/
 /LATEST
 /*_1
 test/integration/trash/
+Gemfile.lock

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Unreleased
 
+# 0.15.0
+
+- Encode pure ASCII strings in Rack env as UTF-8, as allowed by the rack spec.
+  Other strings remain as ASCII-8BIT aka BINARY as required by the rack spec.
+- Fix compatibility with Rack 3.1.
+- Fix `rack.hijack` support.
+- Support Rack 3 streaming bodies.
+- Implement listen queues for fairer load balancing (optional).
+- Assume C99 compatible compiler.
+- Declare dependency on `logger` for Ruby 3.5 compatibility.
+
 # 0.14.0
 
 - Remove the dependency on `raindrops`.

data/Gemfile

@@ -5,6 +5,9 @@ source "https://rubygems.org"
 gem 'minitest'
 gem 'rake'
 gem 'rake-compiler'
+if ENV["RACK_VERSION"]
+  gem "rack", ENV["RACK_VERSION"]
+end
 
 group :benchmark do
   gem "puma"

data/docs/CONFIGURATION.md

@@ -60,6 +60,10 @@ The following options may be specified (but are generally not needed):
 
   Default: `1024`
 
+  Note: if the `queue` option is used, each queue gets an equal share of the
+  total `backlog`. e.g. `backlog: 1028, queues: 8` create `8` sockets with a
+  backlog of `128`.
+
   Note: with the Linux kernel, the net.core.somaxconn sysctl defaults
   to 128, capping this value to 128.  Raising the sysctl allows a
   larger backlog (which may not be desirable with multiple,
@@ -136,6 +140,34 @@ The following options may be specified (but are generally not needed):
 
   Default: `false` (unset)
 
+- `queues: Integer`
+
+  Create multiple server sockets (using `reuseport`) and split them
+  between workers to ensure fairer load balancing.
+
+  Linux's `epoll+accept` queue is fundamentally LIFO (see a good writeup at
+  https://blog.cloudflare.com/the-sad-state-of-linux-socket-balancing/).
+
+  Because of this, the workers with the lowest PID will accept
+  disproportionally more requests than workers with higher PID.
+  It generally isn't a problem, especially when reforking is enabled, but for
+  applications that are routinely over provisioned, it may be desirable to
+  ensure all workers at least get some incoming requests so the can warm up.
+
+  Creating more than one queue allow to restrict which worker can process
+  a given incomming request, hence making the load balancing fairer.
+
+  However it is to be used with care, because if the queueing is made too
+  granular, this may cause pockets of request queueing.
+
+  Default: `1` (unset)
+
+- `queues_per_worker: Integer`
+
+  Controls how many queues each worker is assigned.
+
+  Default: `queues - 1`.
+
 - `umask: mode`
 
   Sets the file mode creation mask for UNIX sockets.

data/docs/FORK_SAFETY.md

@@ -83,7 +83,8 @@ impact of discovering such bug.
 - The `grpc` isn't fork safe by default, but starting from version `1.57.0`, it does provide an experimental
   fork safe option that requires setting an environment variable before loading the library, and calling
   `GRPC.prefork`, `GRPC.postfork_parent` and `GRPC.postfork_child` around fork calls.
-  (https://github.com/grpc/grpc/pull/33430)
+  (https://github.com/grpc/grpc/pull/33430).
+  You can also use the [`grpc_fork_safety`](https://github.com/Shopify/grpc_fork_safety) gem to make it easier.
 
 - The `ruby-vips` gem binds the `libvips` image processing library that isn't fork safe.
   (https://github.com/libvips/libvips/discussions/3577)

data/ext/pitchfork_http/common_field_optimization.h

@@ -61,19 +61,20 @@ static struct common_field common_http_fields[] = {
 #define HTTP_PREFIX_LEN (sizeof(HTTP_PREFIX) - 1)
 static ID id_uminus;
 
+/* This helper is used to create rack env keys, they should be UTF-8 */
 #ifdef HAVE_RB_ENC_INTERNED_STR
 static VALUE str_new_dd_freeze(const char *ptr, long len)
 {
   if (RB_ENC_INTERNED_STR_NULL_CHECK && len == 0) {
-      return rb_enc_interned_str("", len, rb_ascii8bit_encoding());
+      return rb_enc_interned_str("", len, rb_utf8_encoding());
   } else {
-      return rb_enc_interned_str(ptr, len, rb_ascii8bit_encoding());
+      return rb_enc_interned_str(ptr, len, rb_utf8_encoding());
   }
 }
 #else
 static VALUE str_new_dd_freeze(const char *ptr, long len)
 {
-  VALUE str = rb_str_new(ptr, len);
+  VALUE str = rb_utf8_str_new(ptr, len);
   return rb_funcall(str, id_uminus, 0);
 }
 #endif
@@ -119,12 +120,14 @@ static VALUE find_common_field(const char *field, size_t flen)
  */
 static VALUE uncommon_field(const char *field, size_t flen)
 {
-  VALUE f = rb_str_new(NULL, HTTP_PREFIX_LEN + flen);
+  VALUE f = rb_utf8_str_new(NULL, HTTP_PREFIX_LEN + flen);
   memcpy(RSTRING_PTR(f), HTTP_PREFIX, HTTP_PREFIX_LEN);
   memcpy(RSTRING_PTR(f) + HTTP_PREFIX_LEN, field, flen);
   assert(*(RSTRING_PTR(f) + RSTRING_LEN(f)) == '\0' &&
          "string didn't end with \\0"); /* paranoia */
-  return f;
+  // We freeze the value because it will be used as a hash key,
+  // so if we don't Hash#[]= will dup it.
+  return rb_str_freeze(f);
 }
 
 #endif /* common_field_optimization_h */

data/ext/pitchfork_http/extconf.rb

@@ -3,9 +3,12 @@
 require 'mkmf'
 
 append_cflags("-fvisibility=hidden")
+append_cflags("-std=c99")
+
 have_const("PR_SET_CHILD_SUBREAPER", "sys/prctl.h")
 have_func("rb_enc_interned_str", "ruby.h") # Ruby 3.0+
 have_func("rb_io_descriptor", "ruby.h") # Ruby 3.1+
+have_func("rb_hash_new_capa", "ruby.h") # Ruby 3.2+
 have_func("getpagesize", "unistd.h")
 
 if RUBY_VERSION.start_with?('3.0.')