pitchfork 0.11.0 → 0.11.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3b4583ce30977e64c83d59160b7798f93073c6d0935d77c552e91397388bb434
-  data.tar.gz: 02c2c0abe2a400496c07bbe7f41c4d316eaed60b69a7681518a805b8e6f91a4a
+  metadata.gz: 5dc129b2e6e6e940be0f9e388400a376614a65a125a64b68c73b919744c433b3
+  data.tar.gz: b12e1d5f360edc7159567060c095b40510e8e89c54dae058882742c29c830f78
 SHA512:
-  metadata.gz: 21360afc97d6172038ad4bfeae1c0fab4eeef787024c5a6743b0fb72fd61feb259666f0e9b0d519c9173072505f6f205d4bec2d764ec964173ea9116be20336f
-  data.tar.gz: b1faf79e0f186011c41523ff6bacc50a8ab1ad039fc0a9e934abc8fb17ffbbedcf9295fa50415f650b2a7ca30e019d3825079da1f83eaf10068c24c2b1734b08
+  metadata.gz: 4a43b0204dc0e77a4d28007dbfd89e9645724a4198ea6ec7ffa0895aefaf075bd42d4303c37d0f7e61afb550b665b78ab6b22ca9f934ef2d3721883acf0a68cd
+  data.tar.gz: 7eb41807d6971ac948ee264b1f70fd2e16afcf8f289655073c876b752a53a405b9705e97509f5be82c519ee12694ecf1910b18a20cce8aad3ce9a4ffd3af9ac6

data/.github/workflows/ci.yml

@@ -10,7 +10,7 @@ jobs:
       fail-fast: false
       matrix:
         os: ["ubuntu-latest"]
-        ruby: ["3.2", "3.1", "3.0", "2.7", "2.6"]
+        ruby: ["ruby-head", "3.3", "3.2", "3.1", "3.0", "2.7", "2.6"]
     runs-on: ubuntu-latest
     steps:
       - name: Check out code

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Unreleased
 
+# 0.11.1
+
+- Fix Ruby 3.4-dev compatibility.
+
 # 0.11.0
 
 - Drop invalid response headers.

data/Gemfile.lock

@@ -1,18 +1,18 @@
 PATH
   remote: .
   specs:
-    pitchfork (0.11.0)
+    pitchfork (0.11.1)
       rack (>= 2.0)
       raindrops (~> 0.7)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    minitest (5.15.0)
-    nio4r (2.5.9)
-    puma (6.3.1)
+    minitest (5.22.2)
+    nio4r (2.7.0)
+    puma (6.4.2)
       nio4r (~> 2.0)
-    rack (3.0.8)
+    rack (3.0.9.1)
     raindrops (0.20.1)
     rake (13.0.6)
     rake-compiler (1.2.1)
@@ -20,8 +20,7 @@ GEM
 
 PLATFORMS
   aarch64-linux
-  arm64-darwin-21
-  arm64-darwin-22
+  arm64-darwin
   x86_64-linux
 
 DEPENDENCIES

data/docs/DESIGN.md

@@ -49,7 +49,7 @@
   nothing to accept().
 
 * Since non-blocking accept() is used, there can be a thundering
-  herd when an occasional client connects when application
+  herd when an occasional client connects when the application
   *is not busy*.  The thundering herd problem should not affect
   applications that are running all the time since worker processes
   will only select()/accept() outside of the application dispatch.

data/docs/FORK_SAFETY.md

@@ -3,11 +3,11 @@
 Because `pitchfork` is a preforking server, your application code and libraries
 must be fork safe.
 
-Generally code might be fork-unsafe for one of two reasons
+Generally, code might be fork-unsafe for one of two reasons.
 
 ## Inherited Connection
 
-When a process is forked, any open file descriptor (sockets, files, pipes, etc)
+When a process is forked, any open file descriptors (sockets, files, pipes, etc)
 end up shared between the parent and child process. This is never what you
 want, so any code keeping persistent connections should close them either
 before or after the fork happens.
@@ -39,7 +39,7 @@ The documentation of any database client or network library you use should be
 read with care to figure out how to disconnect it, and whether it is best to
 do it before or after fork.
 
-Since the most common Ruby application servers `Puma`, `Unicorn` and `Passenger`
+Since the most common Ruby application servers like `Puma`, `Unicorn` and `Passenger`
 have forking at least as an option, the requirements are generally well documented.
 
 However what is novel with `Pitchfork`, is that processes can be forked more than once.
@@ -61,7 +61,7 @@ So any libraries that spawn a background thread for periodical work may need to
 that a fork happened and that it should restart its thread.
 
 Just like with connections, some libraries take on them to automatically restart their background
-thread when they detect a fork happened.
+thread when they detect that a fork happened.
 
 # Refork Safety
 
@@ -71,7 +71,7 @@ but not work in Pitchfork when reforking is enabled.
 This is because it is not uncommon for network connections or background threads to only be
 initialized upon the first request. As such they're not inherited on the first fork.
 
-However when reforking is enabled, new processes as forked out of warmed up process, as such
+However when reforking is enabled, new processes are forked out of a warmed up process, as such
 any lazily created connection is much more likely to have been created.
 
 As such, if you enable reforking for the first time, it is heavily recommended to first do it
@@ -88,4 +88,6 @@ impact of discovering such bug.
 - The `ruby-vips` gem binds the `libvips` image processing library that isn't fork safe.
   (https://github.com/libvips/libvips/discussions/3577)
 
-No other gem is known to be incompatible for now, but if you find one please open an issue to add it to the list.
+- Any gem binding with `libgobject`, such as the `gda` gem, likely aren't fork safe.
+
+No other gem is known to be incompatible for now, but if you find one, please open an issue to add it to the list.

data/docs/PHILOSOPHY.md

@@ -80,8 +80,8 @@ Suitable options include `nginx`, `caddy` and likely several others.
 One of the main advantages of threaded servers over preforking servers is their
 lower memory usage.
 
-However `pitchfork` solves this with its reforking feature. If enabled and properly configured
-it very significantly increase Copy-on-Write performance, closing the gap with threaded servers.
+However `pitchfork` solves this with its reforking feature. If enabled and properly configured,
+it can very significantly increase Copy-on-Write performance, closing the gap with threaded servers.
 
 ## Assume Modern Deployment Methods
 

data/docs/REFORKING.md

@@ -21,7 +21,7 @@ forked processes are essentially free.
 So in theory, preforking servers shouldn't use more memory than threaded servers.
 
 However, in a Ruby process, there is generally a lot of memory regions that are lazily initialized.
-This include the Ruby Virtual Machine inline caches, JITed code if you use YJIT, and also
+This includes the Ruby Virtual Machine inline caches, JITed code if you use YJIT, and also
 some common patterns in applications, such as memoization:
 
 ```ruby
@@ -35,13 +35,13 @@ end
 However, since workers are forked right after boot, most codepaths have never been executed,
 so most of these caches are not yet initialized.
 
-As more code get executed, more an more memory pages get invalidated. If you were to graph the ratio
-of shared memory of a ruby process over time, you'd likely see a logarithmic curve, with a quick degradation
+As more code gets executed, more and more memory pages get invalidated. If you were to graph the ratio
+of shared memory of a Ruby process over time, you'd likely see a logarithmic curve, with a quick degradation
 during the first few processed request as the most common code paths get warmed up, and then a stabilization.
 
 ### Reforking
 
-That is where reforking helps. Since move of these invalidations only happens when a codepath is executed for the
+That is where reforking helps. Since most of these invalidations only happen when a code path is executed for the
 first time, if you take a warmed up worker out of rotation, and use it to fork new workers, warmed up pages will
 be shared again, and most of them won't be invalidated anymore.
 
@@ -123,9 +123,9 @@ PID   COMMAND
 ```
 
 However the `pitchfork` master process registers itself as a "child subreaper" via [`PR_SET_CHILD_SUBREAPER`](https://man7.org/linux/man-pages/man2/prctl.2.html).
-This means any descendant process that is orphaned will be re-parented as a child of the master rather than a child of the init process (pid 1).
+This means that any descendant process that is orphaned will be re-parented as a child of the master process rather than a child of the init process (pid 1).
 
-With this in mind, the mold forks twice to create an orphaned process that will get re-attached to the master,
+With this in mind, the mold forks twice to create an orphaned process that will get re-attached to the master process,
 effectively forking a sibling rather than a child. Similarly, workers do the same when forking new molds.
 This technique eases killing previous generations of molds and workers.
 

data/docs/SIGNALS.md

@@ -1,6 +1,6 @@
 ## Signal handling
 
-In general, signals need only be sent to the master process. However,
+In general, signals need to only be sent to the master process. However,
 the signals Pitchfork uses internally to communicate with the worker
 processes are documented here as well.
 
@@ -22,8 +22,8 @@ processes are documented here as well.
 ### Worker Processes
 
 Note: the master uses a pipe to signal workers
-instead of `kill(2)` for most cases.  Using signals still (and works and
-remains supported for external tools/libraries), however.
+instead of `kill(2)` for most cases.  Using signals still works and
+remains supported for external tools/libraries, however.
 
 Sending signals directly to the worker processes should not normally be
 needed.  If the master process is running, any exited worker will be

data/ext/pitchfork_http/epollexclusive.h

@@ -21,6 +21,16 @@
 #  define USE_EPOLL (0)
 #endif
 
+#ifndef HAVE_RB_IO_DESCRIPTOR /* Ruby < 3.1 */
+static int rb_io_descriptor(VALUE io)
+{
+    rb_io_t *fptr;
+    GetOpenFile(io, fptr);
+    rb_io_check_closed(fptr);
+    return fptr->fd;
+}
+#endif
+
 #if USE_EPOLL
 /*
  * :nodoc:
@@ -54,8 +64,7 @@ static VALUE prep_readers(VALUE cls, VALUE readers)
 		 */
 		e.events = EPOLLEXCLUSIVE | EPOLLIN;
 		io = rb_io_get_io(io);
-		GetOpenFile(io, fptr);
-		rc = epoll_ctl(epfd, EPOLL_CTL_ADD, fptr->fd, &e);
+		rc = epoll_ctl(epfd, EPOLL_CTL_ADD, rb_io_descriptor(io), &e);
 		if (rc < 0) rb_sys_fail("epoll_ctl");
 	}
 	return epio;
@@ -65,7 +74,7 @@ static VALUE prep_readers(VALUE cls, VALUE readers)
 #if USE_EPOLL
 struct ep_wait {
 	struct epoll_event event;
-	rb_io_t *fptr;
+	VALUE io;
 	int timeout_msec;
 };
 
@@ -79,7 +88,7 @@ static void *do_wait(void *ptr) /* runs w/o GVL */
 	 * at-a-time (c.f. fs/eventpoll.c in linux.git, it's quite
 	 * easy-to-understand for anybody familiar with Ruby C).
 	 */
-	return (void *)(long)epoll_wait(epw->fptr->fd, &epw->event, 1,
+	return (void *)(long)epoll_wait(rb_io_descriptor(epw->io), &epw->event, 1,
 					epw->timeout_msec);
 }
 
@@ -93,11 +102,10 @@ get_readers(VALUE epio, VALUE ready, VALUE readers, VALUE timeout_msec)
 
 	Check_Type(ready, T_ARRAY);
 	Check_Type(readers, T_ARRAY);
-	epio = rb_io_get_io(epio);
-	GetOpenFile(epio, epw.fptr);
-
+	epw.io = rb_io_get_io(epio);
 	epw.timeout_msec = NUM2INT(timeout_msec);
 	n = (long)rb_thread_call_without_gvl(do_wait, &epw, RUBY_UBF_IO, NULL);
+	RB_GC_GUARD(epw.io);
 	if (n < 0) {
 		if (errno != EINTR) rb_sys_fail("epoll_wait");
 	} else if (n > 0) { /* maxevents is hardcoded to 1 */

data/ext/pitchfork_http/extconf.rb

@@ -3,6 +3,8 @@ require 'mkmf'
 
 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+
+
 if RUBY_VERSION.start_with?('3.0.')
   # https://bugs.ruby-lang.org/issues/18772
   $CFLAGS << ' -DRB_ENC_INTERNED_STR_NULL_CHECK=1 '

data/lib/pitchfork/http_parser.rb

@@ -193,7 +193,12 @@ module Pitchfork
 
     # called by ext/pitchfork_http/pitchfork_http.rl via rb_funcall
     def self.is_chunked?(v) # :nodoc:
-      vals = v.split(/[ \t]*,[ \t]*/).map!(&:downcase)
+      vals = v.split(',')
+      vals.each do |val|
+        val.strip!
+        val.downcase!
+      end
+
       if vals.pop == 'chunked'.freeze
         return true unless vals.include?('chunked'.freeze)
         raise Pitchfork::HttpParserError, 'double chunked', []

data/lib/pitchfork/http_server.rb

@@ -722,6 +722,7 @@ module Pitchfork
 
       proc_name status: "requests: #{worker.requests_count}, processing: #{env["PATH_INFO"]}"
 
+      env["pitchfork.worker"] = worker
       timeout_handler.rack_env = env
       env["pitchfork.timeout"] = timeout_handler
 
@@ -1049,7 +1050,7 @@ module Pitchfork
           exit
         end
       else
-        clean_fork(&block)
+        Pitchfork.clean_fork(&block)
       end
     end
 

data/lib/pitchfork/version.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Pitchfork
-  VERSION = "0.11.0"
+  VERSION = "0.11.1"
   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.11.0
+  version: 0.11.1
 platform: ruby
 authors:
 - Jean Boussier
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-12-14 00:00:00.000000000 Z
+date: 2024-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: raindrops
@@ -138,7 +138,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.5.5
 signing_key:
 specification_version: 4
 summary: Rack HTTP server for fast clients and Unix