puma 8.1.0-java → 8.1.1-java

data/docs/cluster_mode.md

@@ -0,0 +1,241 @@
+# Cluster mode
+
+Puma also offers "cluster mode". Cluster mode `fork`s workers from a master process. Each child process still has its own thread pool. You can tune the number of workers with the `-w` (or `--workers`) flag:
+
+```
+$ puma -t 8:32 -w 3
+```
+
+Or with the `WEB_CONCURRENCY` environment variable:
+
+```
+$ WEB_CONCURRENCY=3 puma -t 8:32
+```
+
+When using a config file, most applications can simply set `workers :auto` (requires the `concurrent-ruby` gem) to match the number of worker processes to the available processors:
+
+```ruby
+# config/puma.rb
+workers :auto
+```
+
+See [`workers :auto` gotchas](../lib/puma/dsl.rb).
+
+Note that threads are still used in cluster mode, and the `-t` thread flag setting is per worker, so `-w 2 -t 16:16` will spawn 32 threads in total, with 16 in each worker process.
+
+If `workers` is set to `:auto`, or the `WEB_CONCURRENCY` environment variable is set to `"auto"`, and the `concurrent-ruby` gem is available in your application, Puma will set the worker process count to the result of [available processors](https://msp-greg.github.io/concurrent-ruby/Concurrent.html#available_processor_count-class_method).
+
+For an in-depth discussion of the tradeoffs of thread and process count settings, [see our docs](deployment/README.md).
+
+In cluster mode, Puma can "preload" your application. This loads all the application code *prior* to forking. Preloading reduces total memory usage of your application via an operating system feature called [copy-on-write](https://en.wikipedia.org/wiki/Copy-on-write).
+
+If the number of workers is greater than 1 (and `--prune-bundler` has not been specified), preloading will be enabled by default. Otherwise, you can use the `--preload` flag from the command line:
+
+```
+$ puma -w 3 --preload
+```
+
+Or, if you're using a configuration file, you can use the `preload_app!` method:
+
+```ruby
+# config/puma.rb
+workers 3
+preload_app!
+```
+
+Preloading can’t be used with phased restart, since phased restart kills and restarts workers one-by-one, and preloading copies the code of master into the workers.
+
+## Cluster mode hooks
+
+When using clustered mode, Puma's configuration DSL provides `before_fork`, `before_worker_boot`, and `after_worker_shutdown`
+hooks to run code when the master process forks, the child workers are booted, and after each child worker exits respectively.
+
+It is recommended to use these hooks with `preload_app!`, otherwise constants loaded by your
+application (such as `Rails`) will not be available inside the hooks.
+
+```ruby
+# config/puma.rb
+before_fork do
+  # Add code to run inside the Puma master process before it forks a worker child.
+end
+
+before_worker_boot do
+  # Add code to run inside the Puma worker process after forking.
+end
+
+after_worker_shutdown do |worker_handle|
+  # Add code to run inside the Puma master process after a worker exits. `worker.process_status` can be used to get the
+  # `Process::Status` of the exited worker.
+end
+```
+
+In addition, there are `before_refork` and `after_refork` hooks which are used only in [`fork_worker` mode](#fork-worker-cluster-mode-experimental),
+when the worker 0 child process forks a grandchild worker:
+
+```ruby
+before_refork do
+  # Used only when fork_worker mode is enabled. Add code to run inside the Puma worker 0
+  # child process before it forks a grandchild worker.
+end
+```
+
+```ruby
+after_refork do
+  # Used only when fork_worker mode is enabled. Add code to run inside the Puma worker 0
+  # child process after it forks a grandchild worker.
+end
+```
+
+Importantly, note the following considerations when Ruby forks a child process:
+
+1. File descriptors such as network sockets **are** copied from the parent to the forked
+   child process. Dual-use of the same sockets by parent and child will result in I/O conflicts
+   such as `SocketError`, `Errno::EPIPE`, and `EOFError`.
+2. Background Ruby threads, including threads used by various third-party gems for connection
+   monitoring, etc., are **not** copied to the child process. Often this does not cause
+   immediate problems until a third-party connection goes down, at which point there will
+   be no supervisor to reconnect it.
+
+Therefore, we recommend the following:
+
+1. If possible, do not establish any socket connections (HTTP, database connections, etc.)
+   inside Puma's master process when booting.
+2. If (1) is not possible, use `before_fork` and `before_refork` to disconnect the parent's socket
+   connections when forking, so that they are not accidentally copied to the child process.
+3. Use `before_worker_boot` to restart any background threads on the forked child.
+4. Use `after_refork` to restart any background threads on the parent.
+
+## Fork-Worker Cluster Mode [Experimental]
+
+`fork_worker` (`--fork-worker` from the CLI) is an experimental cluster-mode configuration option. This mode causes Puma to fork additional workers from worker 0, instead of directly from the master process.
+
+```
+10000   \_ puma 8.0.2 (tcp://0.0.0.0:9292) [puma]
+10001       \_ puma: cluster worker 0: 10000 [puma]
+10002           \_ puma: cluster worker 1: 10000 [puma]
+10003           \_ puma: cluster worker 2: 10000 [puma]
+10004           \_ puma: cluster worker 3: 10000 [puma]
+```
+
+The `fork_worker` option allows your application to be initialized only once for copy-on-write memory savings, and it has two additional advantages:
+
+1. **Compatible with phased restart.** With `preload_app!` disabled, the master process doesn't load the application, so this mode works with phased restart (`SIGUSR1` or `pumactl phased-restart`). When worker 0 reloads as part of a phased restart, it initializes a new copy of your application first, then the other workers reload by forking from this new worker already containing the new preloaded application.
+
+   This allows a phased restart to complete as quickly as a hot restart (`SIGUSR2` or `pumactl restart`), while still minimizing downtime by staggering the restart across cluster workers.
+
+2. **'Refork' for additional copy-on-write improvements in running applications.** Fork-worker mode introduces a new `refork` command that re-loads all nonzero workers by re-forking them from worker 0.
+
+   This command can potentially improve memory utilization in large or complex applications that don't fully pre-initialize on startup, because the re-forked workers can share copy-on-write memory with a worker that has been running for a while and serving requests.
+
+   You can trigger a refork by sending the cluster the `SIGURG` signal or running the `pumactl refork` command at any time. A refork will also automatically trigger once, after a certain number of requests have been processed by worker 0 (default 1000). To configure the number of requests before the auto-refork, pass a positive integer argument to `fork_worker` (e.g., `fork_worker 1000`), or `0` to disable.
+
+### Usage Considerations
+
+- `fork_worker` introduces new `before_refork` and `after_refork` configuration hooks. Note the following:
+    - When initially forking the parent process to the worker 0 child, `before_fork` will trigger on the parent process and `before_worker_boot` will trigger on the worker 0 child as normal.
+    - When forking the worker 0 child to grandchild workers, `before_refork` and `after_refork` will trigger on the worker 0 child, and `before_worker_boot` will trigger on each grandchild worker.
+    - For clarity, `before_fork` does not trigger on worker 0, and `after_refork` does not trigger on the grandchild.
+- As a general migration guide:
+    - Copy any logic within your existing `before_fork` hook to the `before_refork` hook.
+    - Consider copying logic from your `before_worker_boot` hook to the `after_refork` hook, if it is needed to reset the state of worker 0 after it forks.
+
+### Limitations
+
+- This mode is still very experimental so there may be bugs or edge-cases, particularly around expected behavior of existing hooks. Please open a [bug report](https://github.com/puma/puma/issues/new?template=bug_report.md) if you encounter any issues.
+
+- In order to fork new workers cleanly, worker 0 shuts down its server and stops serving requests so there are no open file descriptors or other kinds of shared global state between processes, and to maximize copy-on-write efficiency across the newly-forked workers. This may temporarily reduce total capacity of the cluster during a phased restart / refork.
+
+- In a cluster with `n` workers, a normal phased restart stops and restarts workers one by one while the application is loaded in each process, so `n-1` workers are available serving requests during the restart. In a phased restart in fork-worker mode, the application is first loaded in worker 0 while `n-1` workers are available, then worker 0 remains stopped while the rest of the workers are reloaded one by one, leaving only `n-2` workers to be available for a brief period of time. Reloading the rest of the workers should be quick because the application is preloaded at that point, but there may be situations where it can take longer (slow clients, long-running application code, slow worker-fork hooks, etc).
+
+## Mold-Worker Cluster Mode [Experimental]
+
+`mold_worker` (`--mold-worker` from the CLI) is an alternative to `fork_worker`. Instead of forking from a worker that also serves requests, Puma promotes a worker to a "mold", which stops serving requests and only forks new workers. Because the mold never serves traffic, a slow request, timeout or memory limit can't take it down mid-refork.
+
+```
+10000   \_ puma 8.0.2 (tcp://0.0.0.0:9292) [puma]
+10005       \_ puma: mold 2: 10000 [puma]
+10011           \_ puma: cluster worker 0: 10000 [puma]
+10012           \_ puma: cluster worker 1: 10000 [puma]
+10013           \_ puma: cluster worker 2: 10000 [puma]
+```
+
+Workers are forked from the master at boot. Each request threshold (default `1000`) promotes the busiest worker to a new mold, retires the previous one, and reforks every worker from the new mold.
+
+```ruby
+mold_worker 1000, 2000, 4000
+```
+
+### Usage Considerations
+
+- Thresholds are per worker, counted from when that worker booted. Workers forked from a mold start again at zero, so with the config above a worker is promoted after 1000 requests, and a worker from that generation is promoted after another 2000.
+- After the last threshold, molds are only replaced by `SIGURG` or `pumactl refork`, which promote the busiest worker at any time.
+- A phased restart (`SIGUSR1` or `pumactl phased-restart`) retires the mold and forks workers from the master, so new code is loaded, then starts the thresholds again. As with any phased restart, this requires `preload_app!` to be disabled.
+- `mold_worker` cannot be combined with `fork_worker`.
+- On Linux 3.4+, workers are reparented to the master rather than orphaned if their mold exits.
+- `mold_worker` introduces new `after_mold_promotion` and `before_mold_shutdown` configuration hooks.
+    - `after_mold_promotion` runs in the mold after it stops serving requests, before it forks any workers. Use it for what you would do in `before_refork`, such as closing connections or running garbage collection.
+    - `before_mold_shutdown` runs in the mold before it exits.
+    - `before_worker_boot` runs in each forked worker, as usual. Use it for what you would do in `after_refork`.
+
+## Using gRPC with Puma in Clustered Mode
+
+This guide shows how to set up gRPC with Puma in a clustered environment using Puma's hooks to manage gRPC's lifecycle methods during forking.
+
+### The Problem
+
+In a clustered Puma setup, you might encounter the following error when using gRPC:
+
+```
+grpc cannot be used between calls to GRPC.prefork and GRPC.postfork_child or GRPC.postfork_parent
+```
+
+To work correctly, gRPC needs these methods called at specific points in the process lifecycle:
+- `GRPC.prefork`: Called before forking.
+- `GRPC.postfork_child`: Called in the child process after forking.
+- `GRPC.postfork_parent`: Called in the parent process after forking.
+
+Puma provides hooks such as `before_worker_fork`, `after_worker_fork`, and `before_worker_boot` to execute code during these lifecycle events. Understanding the behavior of these hooks is key to ensuring gRPC operates correctly in a clustered setup.
+
+### The Solution
+
+#### Example Configuration
+
+This configuration integrates gRPC's lifecycle methods in a clustered Puma setup and works whether preloading is enabled or not.
+
+```ruby
+# config/puma.rb
+
+is_mac = RUBY_PLATFORM.include?("darwin")
+
+before_worker_fork do |index|
+  GRPC.prefork unless is_mac
+end
+
+after_worker_fork do |index|
+  GRPC.postfork_parent unless is_mac
+end
+
+before_worker_boot do
+  GRPC.postfork_child unless is_mac
+end
+```
+
+#### Understanding the Lifecycle and Hooks
+
+Puma's hooks determine when to call gRPC's lifecycle methods. Each hook plays a specific role in managing the lifecycle during forking:
+
+- **`before_worker_fork`**:
+  - This hook runs before forking workers and is where you call `GRPC.prefork`.
+  - In preloading setups (default in Puma v7), it runs in the **master process** before workers are forked, as the application is preloaded in the master process.
+  - Without preloading, it still runs in the **master process** before forking workers, but the application is not preloaded.
+  - `GRPC.prefork` is called here to prepare GRPC for the forking process.
+
+- **`after_worker_fork`**:
+  - This hook always runs in the **master process** after a worker is forked, regardless of whether preloading is enabled.
+  - Call `GRPC.postfork_parent` here to finalize the master process's state after forking.
+
+- **`before_worker_boot`**:
+  - This hook always runs in the **worker process** after it is forked, regardless of whether preloading is enabled.
+  - Call `GRPC.postfork_child` here to finalize the worker's state.
+
+**Note**: On macOS, these methods are skipped because gRPC does not require them due to differences in how forking works.

data/docs/configuration.md

@@ -0,0 +1,78 @@
+# Configuration
+
+## Configuration File
+
+You can also provide a configuration file with the `-C` (or `--config`) flag:
+
+```
+$ puma -C /path/to/config
+```
+
+If no configuration file is specified, Puma will look for a configuration file at `config/puma.rb`. If an environment is specified (via the `--environment` flag or through the `APP_ENV`, `RACK_ENV`, or `RAILS_ENV` environment variables) Puma looks for a configuration file at `config/puma/<environment_name>.rb` and then falls back to `config/puma.rb`.
+
+If you want to prevent Puma from looking for a configuration file in those locations, include the `--no-config` flag:
+
+```
+$ puma --no-config
+
+# or
+
+$ puma -C "-"
+```
+
+The other side-effects of setting the environment are whether to show stack traces (in `development` or `test`), and setting RACK_ENV may potentially affect middleware looking for this value to change their behavior. The default puma RACK_ENV value is `development`. You can see all config default values in `Puma::Configuration#puma_default_options` or [configuration.rb](https://github.com/puma/puma/blob/61c6213fbab/lib/puma/configuration.rb#L182-L204).
+
+## Thread Pool
+
+Puma uses a thread pool. You can set the minimum and maximum number of threads that are available in the pool with the `-t` (or `--threads`) flag:
+
+```
+$ puma -t 8:32
+```
+
+Puma will automatically scale the number of threads, from the minimum until it caps out at the maximum, based on how much traffic is present. The current default is `0:16` and on MRI is `0:5`. Feel free to experiment, but be careful not to set the number of maximum threads to a large number, as you may exhaust resources on the system (or cause contention for the Global VM Lock, when using MRI).
+
+Be aware that additionally Puma creates threads on its own for internal purposes (e.g. handling slow clients). So, even if you specify -t 1:1, expect around 7 threads created in your application.
+
+## Master process lifecycle hooks
+
+Puma's configuration DSL provides master process lifecycle hooks `after_booted`, `before_restart`, and `after_stopped`
+which may be used to specify code blocks to run on each event:
+
+```ruby
+# config/puma.rb
+after_booted do
+  # Add code to run in the Puma master process after it boots,
+  # and also after a phased restart completes.
+end
+
+before_restart do
+  # Add code to run in the Puma master process when it receives
+  # a restart command but before it restarts.
+end
+
+after_stopped do
+  # Add code to run in the Puma master process after outstanding
+  # requests have finished and Puma has stopped.
+end
+```
+
+## Error handling
+
+If Puma encounters an error outside of the context of your application, it will respond with a 400/500 and a simple
+textual error message (see `Puma::Server#lowlevel_error` or [server.rb](https://github.com/puma/puma/blob/main/lib/puma/server.rb)).
+You can specify custom behavior for this scenario. For example, you can report the error to your third-party
+error-tracking service (in this example, [rollbar](https://rollbar.com)):
+
+```ruby
+lowlevel_error_handler do |e, env, status|
+  if status == 400
+    message = "The server could not process the request due to an error, such as an incorrectly typed URL, malformed syntax, or a URL that contains illegal characters.\n"
+  else
+    message = "An error has occurred, and engineers have been informed. Please reload the page. If you continue to have problems, contact support@example.com\n"
+    Rollbar.critical(e)
+  end
+
+  [status, {}, [message]]
+end
+```

data/docs/{stats.md → control_server.md}

@@ -1,3 +1,21 @@
+# Control/Status Server
+
+Puma has a built-in status and control app that can be used to query and control Puma.
+
+```
+$ puma --control-url tcp://127.0.0.1:9293 --control-token foo
+```
+
+Puma will start the control server on localhost port 9293. All requests to the control server will need to include a control token (in this case, `token=foo`) as a query parameter. This allows for simple authentication. Check out `Puma::App::Status` or [status.rb](https://github.com/puma/puma/blob/main/lib/puma/app/status.rb) to see what the status app has available.
+
+You can also interact with the control server via `pumactl`. This command will restart Puma:
+
+```
+$ pumactl --control-url 'tcp://127.0.0.1:9293' --control-token foo restart
+```
+
+To see a list of `pumactl` options, use `pumactl --help`.
+
 ## Accessing stats
 
 Stats can be accessed in two ways:
@@ -6,8 +24,6 @@ Stats can be accessed in two ways:
 
 `$ pumactl stats` or `GET /stats`
 
-[Read more about `pumactl` and the control server in the README.](https://github.com/puma/puma#controlstatus-server).
-
 ### Puma.stats
 
 `Puma.stats` produces a JSON string. `Puma.stats_hash` produces a ruby hash.
@@ -70,7 +86,7 @@ When Puma runs in single mode, these stats are available at the top level. When
 
 ### cluster mode
 
-* phase: which phase of restart the process is in, during [phased restart](https://github.com/puma/puma/blob/main/docs/restart.md)
+* phase: which phase of restart the process is in, during [phased restart](restart.md)
 * workers: ??
 * booted_workers: how many workers are currently running?
 * old_workers: ??
@@ -146,3 +162,7 @@ Here are two example stats hashes produced by `Puma.stats`:
   ]
 }
 ```
+
+## Monitoring
+
+* [puma-status](https://github.com/ylecuyer/puma-status) — Monitor CPU/Mem/Load of running puma instances from the CLI

data/docs/{deployment.md → deployment/README.md}

@@ -41,7 +41,7 @@ Set your config with the following process:
 
 For most deployments, adding `concurrent-ruby` and using `workers :auto` is the right starting point.
 
-See [`workers :auto` gotchas](../lib/puma/dsl.rb).
+See [`workers :auto` gotchas](../../lib/puma/dsl.rb).
 
 ## Worker utilization
 
@@ -117,11 +117,13 @@ and to get paged at 3 AM. Do yourself a favor, at least use the process monitori
 your OS comes with, be it `sysvinit` or `systemd`. Or branch out and use `runit`
 or hell, even `monit`.
 
+Additionally, Puma has support for built-in daemonization via the [puma-daemon](https://github.com/kigster/puma-daemon) ruby gem. The gem restores the `daemonize` option that was removed from Puma starting version 5, but only for MRI Ruby.
+
 ## Restarting
 
 You probably will want to deploy some new code at some point, and you'd like
 Puma to start running that new code. There are a few options for restarting
-Puma, described separately in our [restart documentation](restart.md).
+Puma, described separately in our [restart documentation](../restart.md).
 
 ## Migrating from Unicorn
 
@@ -132,6 +134,20 @@ Puma, described separately in our [restart documentation](restart.md).
 * As you grow more confident in the thread-safety of your app, you can tune the
   workers down and the threads up.
 
-## Ubuntu / Systemd (Systemctl) Installation
+## Process monitors and guides
+
+It is common to use process monitors with Puma. Modern process monitors like systemd or rc.d
+provide continuous monitoring and restarts for increased reliability in production environments:
+
+* [rc.d](rc.d/README.md)
+* [systemd](systemd.md)
+* [Kubernetes](kubernetes.md)
+* [nginx](nginx.md)
+
+Community guides:
+
+* [Deploying Puma on OpenBSD using relayd and httpd](https://gist.github.com/anon987654321/4532cf8d6c59c1f43ec8973faa031103)
+
+## Capistrano
 
-See [systemd.md](systemd.md)
+Puma has support for Capistrano with an [external gem](https://github.com/seuros/capistrano-puma).

data/docs/{kubernetes.md → deployment/kubernetes.md}

@@ -69,5 +69,5 @@ More discussions and links to relevant articles can be found in https://github.c
 
 ## Workers Per Pod, and Other Config Issues
 
-See our [deployment docs](./deployment.md) for more information about how to correctly size your pods and choose the right number of workers and threads.
+See our [deployment docs](README.md) for more information about how to correctly size your pods and choose the right number of workers and threads.
 

data/docs/plugins.md

@@ -1,4 +1,4 @@
-## Plugins
+# Plugins
 
 Puma 3.0 added support for plugins that can augment configuration and service
 operations.
@@ -39,4 +39,63 @@ public API for plugins.
 
 ## Binder hooks
 
-There's a `Puma::Binder#before_parse` method that allows adding a proc to run before the body of `Puma::Binder#parse`. Example of usage can be found in [that repository](https://github.com/anchordotdev/puma-acme/blob/v0.1.3/lib/puma/acme/plugin.rb#L97-L118) (`before_parse_hook` could be renamed `before_parse`, making monkey patching of [binder.rb](https://github.com/anchordotdev/puma-acme/blob/v0.1.3/lib/puma/acme/binder.rb) unnecessary).
+There's a `Puma::Binder#before_parse` method that allows adding a proc to run before the body of `Puma::Binder#parse`. Example of usage can be found in [that repository](https://github.com/anchordotdev/puma-acme/blob/v0.1.3/lib/puma/acme/plugin.rb#L97-L118) (`before_parse_hook` could be renamed `before_parse`, making monkey patching of [binder.rb](https://github.com/anchordotdev/puma-acme/blob/v0.1.3/lib/puma/acme/binder.rb) unnecessary).
+
+## Community plugins
+
+* [puma-metrics](https://github.com/harmjanblok/puma-metrics) — export Puma metrics to Prometheus
+* [puma-plugin-statsd](https://github.com/yob/puma-plugin-statsd) — send Puma metrics to statsd
+* [puma-plugin-systemd](https://github.com/sj26/puma-plugin-systemd) — deeper integration with systemd for notify, status and watchdog. Puma 5.1.0 integrated notify and watchdog, which probably conflicts with this plugin. Puma 6.1.0 added status support which obsoletes the plugin entirely.
+* [puma-plugin-telemetry](https://github.com/babbel/puma-plugin-telemetry) - telemetry plugin for Puma offering various targets to publish
+* [puma-acme](https://github.com/anchordotdev/puma-acme) - automatic SSL/HTTPS certificate provisioning and setup
+
+## Example: stopping Puma via Redis
+
+```ruby
+require 'puma/plugin'
+require 'redis'
+
+# How to stop Puma on Heroku
+# - You can't use normal methods because the dyno is not accessible
+# - There's no file system, no way to send signals
+# but ...
+# - You can use Redis or Memcache; any network distributed key-value
+#   store
+
+# 1. Add this plugin to your 'lib' directory
+# 2. In the `puma.rb` config file add the following lines
+#    === Plugins ===
+#    require './lib/puma/plugin/redis_stop_puma'
+#    plugin 'redis_stop_puma'
+# 3. Now, when you set the redis key "puma::restart::web.1", your web.1 dyno
+#    will restart
+# 4. Sniffing the Heroku logs for R14 errors is application (and configuration)
+#    specific. I use the Logentries service, watch for the pattern and the call
+#    a webhook back into my app to set the Redis key. YMMV
+
+# You can test this locally by setting the DYNO environment variable when
+# when starting puma, e.g. `DYNO=pants.1 puma`
+
+Puma::Plugin.create do
+  def start(launcher)
+
+    hostname = ENV['DYNO']
+    return unless hostname
+
+    redis = Redis.new(url: ENV.fetch('REDIS_URL', nil))
+    return unless redis.ping == 'PONG'
+
+    in_background do
+      while true
+        sleep 2
+        if message = redis.get("puma::restart::#{hostname}")
+          redis.del("puma::restart::#{hostname}")
+          $stderr.puts message
+          launcher.stop
+          break
+        end
+      end
+    end
+  end
+end
+```

data/docs/puma_support.md

@@ -8,12 +8,26 @@ This document's purpose is to help users and contributors of this library make f
 
 Puma is a community-run project. "Support" means "what do the maintainers pay attention to and what are they likely to merge", and doesn't mean that we do anything by any particular date, or even at all. We may all jet off to a private island tomorrow and never speak again.
 
-But, if we do decide to keep devoting our free time to open source software, we will **support the environments (combinations of Ruby version, Ruby implementation, Rack version, and operating system) which run on our CI.**
+But, if we do decide to keep devoting our free time to open source software, we will **support the Ruby versions, Ruby implementations, Rack versions, and operating systems which run on our CI**, in any combination, even combinations that CI doesn't run directly.
 
 If you open a PR or bug report for a combination of those factors outside of our CI matrix, we may still accept it if it's a small and low-risk fix.
 
 We may add environments to CI at any time, but we only drop a supported environment in a minor or major release.
 
+## CI matrix
+
+CI aims for the most coverage with the fewest jobs.
+
+Every OS and architecture runs the oldest supported Ruby on its oldest runner image, and the newest Ruby on its newest image.
+
+On x64, a few more jobs fill in the gaps:
+
+- The newest Ubuntu image that can build every supported Ruby runs all of them.
+- The newest Ubuntu image also runs Ruby head with YJIT, plus JRuby and TruffleRuby and their head versions.
+- The newest Windows image also runs the ucrt and mswin builds.
+- The oldest Ubuntu and Windows images also run the oldest Ruby without SSL.
+- The oldest Ubuntu image also runs the oldest Ruby with the oldest supported Rack.
+
 ## Puma release support policy
 
 By default, Puma supports one release version, the latest release. That means if there is a bug in 3.2.1 (made-up numbers for example only), but the latest release is 4.3.2, the bug must be reproduced in 4.3.2 to qualify for support.

data/docs/restart.md

@@ -1,4 +1,8 @@
-Puma provides three distinct kinds of restart operations, each for different use cases. This document describes "hot restarts" and "phased restarts." The third kind of restart operation is called "refork" and is described in the documentation for [`fork_worker` and `mold_worker`](fork_worker.md).
+# Restart
+
+Puma includes the ability to restart itself. When available (MRI, Rubinius, JRuby), Puma performs a "hot restart". This is the same functionality available in *Unicorn* and *NGINX* which keep the server sockets open between restarts. This makes sure that no pending requests are dropped while the restart is taking place.
+
+Puma provides three distinct kinds of restart operations, each for different use cases. This document describes "hot restarts" and "phased restarts." The third kind of restart operation is called "refork" and is described in the documentation for [`fork_worker` and `mold_worker`](cluster_mode.md#fork-worker-cluster-mode-experimental).
 
 ## Hot restart
 

data/docs/signals.md

@@ -1,3 +1,5 @@
+# Signals
+
 The [unix signal](https://en.wikipedia.org/wiki/Unix_signal) is a method of sending messages between [processes](https://en.wikipedia.org/wiki/Process_(computing)). When a signal is sent, the operating system interrupts the target process's normal flow of execution. There are standard signals that are used to stop a process, but there are also custom signals that can be used for other purposes. This document is an attempt to list all supported signals that Puma will respond to. In general, signals need only be sent to the master process of a cluster.
 
 ## Sending Signals

data/docs/{5.0-Upgrade.md → upgrading/5.0-Upgrade.md}

@@ -10,7 +10,7 @@ Puma 5 brings new experimental performance features, a few quality-of-life featu
 2. Upgrade to version 5.0 in your Gemfile and deploy.
 3. Try the new performance experiments outlined below and report your results back to the Puma issue tracker.
 
-Puma 5 was named Spoony Bard by our newest supercontributor, [@wjordan](https://github.com/puma/puma/commits?author=wjordan). Will brought you one of our new perf features for this release, as well as [many other fixes and refactors.](https://github.com/puma/puma/commits?author=wjordan) If you'd like to name a Puma release in the future, take a look at [CONTRIBUTING.md](../CONTRIBUTING.md) and get started helping us out :)
+Puma 5 was named Spoony Bard by our newest supercontributor, [@wjordan](https://github.com/puma/puma/commits?author=wjordan). Will brought you one of our new perf features for this release, as well as [many other fixes and refactors.](https://github.com/puma/puma/commits?author=wjordan) If you'd like to name a Puma release in the future, take a look at [CONTRIBUTING.md](../../CONTRIBUTING.md) and get started helping us out :)
 
 Puma 5 also welcomes [@MSP-Greg](https://github.com/puma/puma/commits?author=MSP-Greg) as our newest committer. Greg has been instrumental in improving our CI setup and SSL features. Greg also [named our 4.3.0 release](https://github.com/puma/puma/releases/tag/v4.3.0): Mysterious Traveller.
 
@@ -70,7 +70,7 @@ Puma 5 introduces an experimental new cluster-mode configuration option, `fork_w
 
 It is compatible with phased restarts. It also may improve memory usage because the worker process loads additional code after processing requests.
 
-To learn more about using `refork` and `fork_worker`, see ['Fork Worker'](fork_worker.md).
+To learn more about using `refork` and `fork_worker`, see ['Fork Worker'](../cluster_mode.md#fork-worker-cluster-mode-experimental).
 
 ### What else is new?
 
@@ -89,7 +89,7 @@ To learn more about using `refork` and `fork_worker`, see ['Fork Worker'](fork_w
 * If you have been using the `--control` CLI option, update your scripts to use `--control-url`.
 * If you are using `worker_directory` in your config file, change it to `directory`.
 * If you are running MRI, default thread count on Puma is now 5, not 16. This may change the amount of threads running in your threadpool. We believe 5 is a better default for most Ruby web applications on MRI. Higher settings increase latency by causing GVL contention.
-* If you are using a worker count of more than 1, set using `WEB_CONCURRENCY`, Puma will now preload the application by default (disable with `preload_app! false`). We believe this is a better default, but may cause issues in non-Rails applications if you do not have the proper `before` and `after` fork hooks configured. See documentation for your framework. Rails users do not need to change anything. **Please note that it is not possible to use [the phased restart](restart.md) with preloading.**
+* If you are using a worker count of more than 1, set using `WEB_CONCURRENCY`, Puma will now preload the application by default (disable with `preload_app! false`). We believe this is a better default, but may cause issues in non-Rails applications if you do not have the proper `before` and `after` fork hooks configured. See documentation for your framework. Rails users do not need to change anything. **Please note that it is not possible to use [the phased restart](../restart.md) with preloading.**
 * tcp mode and daemonization have been removed without replacement. For daemonization, please use a modern process management solution, such as systemd or monit.
 * `connected_port` was renamed to `connected_ports` and now returns an Array, not an Integer.
 

data/docs/{6.0-Upgrade.md → upgrading/6.0-Upgrade.md}

@@ -9,9 +9,9 @@ Here's what you should do:
 1. Review the Upgrade section below to look for breaking changes that could affect you.
 2. Upgrade to version 6.0 in your Gemfile and deploy.
 3. Open up a new bug issue if you find any problems.
-4. Join us in building Puma! We welcome first-timers. See [CONTRIBUTING.md](../CONTRIBUTING.md).
+4. Join us in building Puma! We welcome first-timers. See [CONTRIBUTING.md](../../CONTRIBUTING.md).
 
-For a complete list of changes, see [History.md](../History.md).
+For a complete list of changes, see [History.md](../../History.md).
 
 ## What's New
 

data/docs/{7.0-Upgrade.md → upgrading/7.0-Upgrade.md}

@@ -7,9 +7,9 @@ Here's what you should do:
 1. Review the Upgrade section below to look for breaking changes that could affect you.
 2. Upgrade to version 7.0 in your Gemfile and deploy.
 3. Open up a new bug issue if you find any problems.
-4. Join us in building Puma! We welcome first-timers. See [CONTRIBUTING.md](../CONTRIBUTING.md).
+4. Join us in building Puma! We welcome first-timers. See [CONTRIBUTING.md](../../CONTRIBUTING.md).
 
-For a complete list of changes, see [History.md](../History.md).
+For a complete list of changes, see [History.md](../../History.md).
 
 ## What's New
 

data/docs/{8.0-Upgrade.md → upgrading/8.0-Upgrade.md}

@@ -7,9 +7,9 @@ Here's what you should do:
 1. Review the Upgrade section below to look for breaking changes that could affect you.
 2. Upgrade to version 8.0 in your Gemfile and deploy.
 3. Open up a new bug issue if you find any problems.
-4. Join us in building Puma! We welcome first-timers. See [CONTRIBUTING.md](./CONTRIBUTING.md).
+4. Join us in building Puma! We welcome first-timers. See [CONTRIBUTING.md](../../CONTRIBUTING.md).
 
-For a complete list of changes, see [History.md](./History.md).
+For a complete list of changes, see [History.md](../../History.md).
 
 ## What's New
 

data/lib/puma/cluster.rb

@@ -269,7 +269,6 @@ module Puma
       @status = :stop if @status == :run
       wakeup!
       @control&.stop true
-      Process.waitall
     end
 
     def halt

data/lib/puma/const.rb

@@ -100,7 +100,7 @@ module Puma
   # too taxing on performance.
   module Const
 
-    PUMA_VERSION = VERSION = "8.1.0"
+    PUMA_VERSION = VERSION = "8.1.1"
     CODE_NAME = "Puma Psychosis"
 
     PUMA_SERVER_STRING = ["puma", PUMA_VERSION, CODE_NAME].join(" ").freeze

data/lib/puma/minissl.rb

@@ -205,10 +205,7 @@ module Puma
       private :queue_ciphertext
 
       def flush_write_buffer
-        return if @write_buffer.empty?
-
-        @socket.write @write_buffer
-        @write_buffer = +''
+        @socket.wait_writable until flush_write_buffer_nonblock
       end
       private :flush_write_buffer