puma 5.2.1-java → 5.2.2-java

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 499a594786c4be683329a79dc8efe90b794c8bccf87863a9389e0bfea4cb647d
-  data.tar.gz: 9e5cfe53997edadbabda41bc3e16299bf371f1e009bd8162a3685cb34d97f9fc
+  metadata.gz: 560d63fd273aee23f37110caf0011f49ba6bd024c076415d434f4d67ab018d0b
+  data.tar.gz: 31f20ebfd82a21afdce44c18352bfa08efe8b43589e86a307881ec7ba6617dcd
 SHA512:
-  metadata.gz: f7000c30aae715931f59933c43e8cfe76aa86e8d35d9b76911e96da1ec30841546ed6c3fbe0d0aa50637f0355d2761896b1aa7df2b529acf0b61eb3eb30c30df
-  data.tar.gz: 0e83d2d9e079bfed5217f27a0755b2e72ee51b08a1066b5c2b0abf94bf36ec0a94adf5fba9a691e84cab07588d72695129c0cbc6c22e486b2b0651e415544707
+  metadata.gz: 55dde02be1029df2192b5e09306d5a738e224f415f9ea288c278fa746c4103cecfd58d0d830ff9a026beb50d1a55ccd9c2e7875235e77e9a30a9df16f781484a
+  data.tar.gz: 69b8152d773645ffc452f60358cb4453aef2186f94e2075da0a73af57bd0d4b0373ec4b47861bd06b068efea339d4cd2cbd1a593a007e52322605235f402eed7

data/History.md

@@ -1,3 +1,9 @@
+## 5.2.2 / 2021-02-22
+
+* Bugfixes
+  * Add `#flush` and `#sync` methods to `Puma::NullIO`  ([#2553])
+  * Restore `sync=true` on `STDOUT` and `STDERR` streams ([#2557])
+
 ## 5.2.1 / 2021-02-05
 
 * Bugfixes
@@ -1702,6 +1708,8 @@ be added back in a future date when a java Puma::MiniSSL is added.
 * Bugfixes
   * Your bugfix goes here <Most recent on the top, like GitHub> (#Github Number)
 
+[#2557]:https://github.com/puma/puma/pull/2557     "PR by @cjlarose, merged 2021-02-22"
+[#2553]:https://github.com/puma/puma/pull/2553     "PR by @olivierbellone, merged 02-10-22"
 [#2550]:https://github.com/puma/puma/pull/2550     "PR by @MSP-Greg, merged 2021-02-05"
 [#2547]:https://github.com/puma/puma/pull/2547     "PR by @wildmaples, merged 2021-02-03"
 [#2543]:https://github.com/puma/puma/pull/2543     "PR by @MSP-Greg, merged 2021-02-01"

data/docs/architecture.md

@@ -4,34 +4,37 @@
 
 ![https://bit.ly/2iJuFky](images/puma-general-arch.png)
 
-Puma is a threaded web server, processing requests across a TCP or UNIX socket.
+Puma is a threaded Ruby HTTP application server, processing requests across a TCP or UNIX socket.
 
-Workers accept connections from the socket and a thread in the worker's thread pool processes the client's request.
+Puma processes (there can be one or many) accept connections from the socket via a thread (in the `Reactor` class). The connection, once fully buffered and read, moves in to the `todo` list, where it will be picked up by a free/waiting thread in the threadpool (the `ThreadPool` class).
 
-Clustered mode is shown/discussed here. Single mode is analogous to having a single worker process.
+Puma works in two main modes: cluster and single. In single mode, only one Puma process is booted. In cluster mode, a `master` process is booted, which prepares (and may boot) the application, and then uses the `fork()` system call to create 1 or more `child` processes. These `child` processes all listen to the same socket. The `master` process does not listen to the socket or process requests - its purpose is mostly to manage and listen for UNIX signals and possibly kill or boot `child` processes.
 
-## Connection pipeline
+We sometimes call `child` processes (or Puma processes in `single` mode) _workers_, and we sometimes call the threads created by Puma's `ThreadPool` _worker threads_.
+
+## How Requests Work
 
 ![https://bit.ly/2zwzhEK](images/puma-connection-flow.png)
 
 * Upon startup, Puma listens on a TCP or UNIX socket.
-  * The backlog of this socket is configured (with a default of 1024), determining how many established but unaccepted connections can exist concurrently.
-  * This socket backlog is distinct from the "backlog" of work as reported by the control server stats. The latter is the number of connections in that worker's "todo" set waiting for a worker thread.
-* By default, a single, separate thread is used to receive HTTP requests across the socket.
-  * When at least one worker thread is available for work, a connection is accepted and placed in this request buffer
-  * This thread waits for entire HTTP requests to be received over the connection
-    * The time spent waiting for the HTTP request body to be received is exposed to the Rack app as `env['puma.request_body_wait']` (milliseconds)
-  * Once received, the connection is pushed into the "todo" set
-* Worker threads pop work off the "todo" set for processing
-  * The thread processes the request via the rack application (which generates the HTTP response)
-  * The thread writes the response to the connection
-  * Finally, the thread become available to process another connection in the "todo" set
-
-### Disabling `queue_requests`
+  * The backlog of this socket is configured (with a default of 1024). This determines the size of the queue for unaccepted connections. Generally, this setting is unimportant and will never be hit in production use. If the backlog is full, the connection will be refused by the operating system.
+  * This socket backlog is distinct from the `backlog` of work as reported by `Puma.stats` or the control server. The backlog as reported by Puma is the number of connections in the process' `todo` set waiting for a thread from the `ThreadPool`.
+* By default, a single, separate thread (created by the `Reactor` class) is used to read and buffer requests from the socket.
+  * When at least one worker thread is available for work, the reactor thread listens to the socket and accepts a request, if one is waiting.
+  * The reactor thread waits for the entire HTTP request to be received.
+    * The time spent waiting for the HTTP request body to be received is exposed to the Rack app as `env['puma.request_body_wait']` (milliseconds).
+  * Once fully buffered and received, the connection is pushed into the "todo" set.
+* Worker threads pop work off the "todo" set for processing.
+  * The worker thread processes the request via `call`ing the configured Rack application. The Rack application generates the HTTP response.
+  * The worker thread writes the response to the connection. Note that while Puma buffers requests via a separate thread, it does not use a separate thread for responses.
+  * Once done, the thread become available to process another connection in the "todo" set.
+
+### `queue_requests`
 
 ![https://bit.ly/2zxCJ1Z](images/puma-connection-flow-no-reactor.png)
 
-The `queue_requests` option is `true` by default, enabling the separate thread used to buffer requests as described above.
+The `queue_requests` option is `true` by default, enabling the separate reactor thread used to buffer requests as described above.
 
 If set to `false`, this buffer will not be used for connections while waiting for the request to arrive.
+
 In this mode, when a connection is accepted, it is added to the "todo" queue immediately, and a worker will synchronously do any waiting necessary to read the HTTP request from the socket.

data/lib/puma/configuration.rb

@@ -206,7 +206,8 @@ module Puma
         :first_data_timeout => Const::FIRST_DATA_TIMEOUT,
         :raise_exception_on_sigterm => true,
         :max_fast_inline => Const::MAX_FAST_INLINE,
-        :io_selector_backend => :auto
+        :io_selector_backend => :auto,
+        :mutate_stdout_and_stderr_to_sync_on_write => true,
       }
     end
 

data/lib/puma/const.rb

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

data/lib/puma/dsl.rb

@@ -888,5 +888,9 @@ module Puma
     def io_selector_backend(backend)
       @options[:io_selector_backend] = backend.to_sym
     end
+
+    def mutate_stdout_and_stderr_to_sync_on_write(enabled=true)
+      @options[:mutate_stdout_and_stderr_to_sync_on_write] = enabled
+    end
   end
 end

data/lib/puma/null_io.rb

@@ -36,6 +36,10 @@ module Puma
       true
     end
 
+    def sync
+      true
+    end
+
     def sync=(v)
     end
 
@@ -44,5 +48,9 @@ module Puma
 
     def write(*ary)
     end
+
+    def flush
+      self
+    end
   end
 end

data/lib/puma/runner.rb

@@ -126,6 +126,11 @@ module Puma
         STDERR.puts "=== puma startup: #{Time.now} ==="
         STDERR.flush unless STDERR.sync
       end
+
+      if @options[:mutate_stdout_and_stderr_to_sync_on_write]
+        STDOUT.sync = true
+        STDERR.sync = true
+      end
     end
 
     def load_and_bind

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puma
 version: !ruby/object:Gem::Version
-  version: 5.2.1
+  version: 5.2.2
 platform: java
 authors:
 - Evan Phoenix
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-02-05 00:00:00.000000000 Z
+date: 2021-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement