puma 7.1.0 → 7.2.1

data/lib/puma/dsl.rb

@@ -216,6 +216,8 @@ module Puma
     #   activate_control_app 'unix:///var/run/pumactl.sock', { auth_token: '12345' }
     # @example
     #   activate_control_app 'unix:///var/run/pumactl.sock', { no_token: true }
+    # @example
+    #   activate_control_app 'unix:///var/run/pumactl.sock', { no_token: true, data_only: true}
     #
     def activate_control_app(url="auto", opts={})
       if url == "auto"
@@ -240,6 +242,7 @@ module Puma
 
       @options[:control_auth_token] = auth_token
       @options[:control_url_umask] = opts[:umask] if opts[:umask]
+      @options[:control_data_only] = opts[:data_only] if opts[:data_only]
     end
 
     # Load additional configuration from a file.
@@ -666,21 +669,27 @@ module Puma
       @options[:state_permission] = permission
     end
 
-    # How many worker processes to run.  Typically this is set to
-    # the number of available cores.
+    # How many worker processes to run. Typically this is set to the number of
+    # available cores.
     #
     # The default is the value of the environment variable +WEB_CONCURRENCY+ if
-    # set, otherwise 0.
+    # set, otherwise 0. Passing +:auto+ will set the value to
+    # +Concurrent.available_processor_count+ (requires the concurrent-ruby gem).
+    # On some platforms (e.g. under CPU quotas) this may be fractional, and Puma
+    # will round down. If it rounds down to 0, Puma will run in single mode and
+    # cluster-only hooks like +before_worker_boot+ will not execute.
+    # If you rely on cluster-only hooks, set an explicit worker count.
     #
-    # @note Cluster mode only.
+    # A value of 0 or nil means run in single mode.
     #
     # @example
     #   workers 2
+    #   workers :auto
     #
     # @see Puma::Cluster
     #
     def workers(count)
-      @options[:workers] = count.to_i
+      @options[:workers] = count.nil? ? 0 : @config.send(:parse_workers, count)
     end
 
     # Disable warning message when running in cluster mode with a single worker.
@@ -995,6 +1004,7 @@ module Puma
     # The default is +true+ if your app uses more than 1 worker.
     #
     # @note Cluster mode only.
+    # @note When using `fork_worker`, this only applies to worker 0.
     #
     # @example
     #   preload_app!
@@ -1378,7 +1388,7 @@ module Puma
     #
     # The default is +:auto+.
     #
-    # @see https://github.com/socketry/nio4r/blob/master/lib/nio/selector.rb
+    # @see https://github.com/socketry/nio4r/blob/main/lib/nio/selector.rb
     #
     def io_selector_backend(backend)
       @options[:io_selector_backend] = backend.to_sym

data/lib/puma/launcher.rb

@@ -42,9 +42,11 @@ module Puma
     #   end
     #   Puma::Launcher.new(conf, log_writer: Puma::LogWriter.stdio).run
     def initialize(conf, launcher_args={})
-      ## Minimal initialization for a potential early restart (e.g. when pruning bundle)
+      ## Minimal initialization before potential early restart (e.g. from bundle pruning)
 
       @config = conf
+      # Advertise the CLI Configuration before config files are loaded
+      Puma.cli_config = @config if defined?(Puma.cli_config)
       @config.clamp
 
       @options = @config.options
@@ -70,8 +72,7 @@ module Puma
 
       env = launcher_args.delete(:env) || ENV
 
-      # Advertise the Configuration
-      Puma.cli_config = @config if defined?(Puma.cli_config)
+      # Log after prune_bundler! to avoid duplicate logging if a restart occurs
       log_config if env['PUMA_LOG_CONFIG']
 
       @binder = Binder.new(@log_writer, @options)

data/lib/puma/reactor.rb

@@ -75,15 +75,12 @@ module Puma
     private
 
     def select_loop
-      close_selector = true
       begin
         until @input.closed? && @input.empty?
           # Wakeup any registered object that receives incoming data.
           # Block until the earliest timeout or Selector#wakeup is called.
           timeout = (earliest = @timeouts.first) && earliest.timeout
-          monitor_wake_up = false
           @selector.select(timeout) do |monitor|
-            monitor_wake_up = true
             wakeup!(monitor.value)
           end
 
@@ -103,18 +100,12 @@ module Puma
         STDERR.puts "Error in reactor loop escaped: #{e.message} (#{e.class})"
         STDERR.puts e.backtrace
 
-        # NoMethodError may be rarely raised when calling @selector.select, which
-        # is odd.  Regardless, it may continue for thousands of calls if retried.
-        # Also, when it raises, @selector.close also raises an error.
-        if !monitor_wake_up && NoMethodError === e
-          close_selector = false
-        else
-          retry
-        end
+        retry
       end
+
       # Wakeup all remaining objects on shutdown.
       @timeouts.each(&@block)
-      @selector.close if close_selector
+      @selector.close
     end
 
     # Start monitoring the object.

data/lib/puma/request.rb

@@ -36,17 +36,19 @@ module Puma
     # Takes the request contained in +client+, invokes the Rack application to construct
     # the response and writes it back to +client.io+.
     #
-    # It'll return +false+ when the connection is closed, this doesn't mean
+    # It'll return +:close+ when the connection is closed, this doesn't mean
     # that the response wasn't successful.
     #
+    # It'll return +:keep_alive+ if the connection is a pipeline or keep-alive connection.
+    # Which may contain additional requests.
+    #
     # It'll return +:async+ if the connection remains open but will be handled
     # elsewhere, i.e. the connection has been hijacked by the Rack application.
     #
     # Finally, it'll return +true+ on keep-alive connections.
     # @param client [Puma::Client]
     # @param requests [Integer]
-    # @return [Boolean,:async]
-    #
+    # @return [:close, :keep_alive, :async]
     def handle_request(client, requests)
       env = client.env
       io_buffer = client.io_buffer
@@ -54,7 +56,7 @@ module Puma
       app_body = nil
       error = nil
 
-      return false if closed_socket?(socket)
+      return :close if closed_socket?(socket)
 
       if client.http_content_length_limit_exceeded
         return prepare_response(413, {}, ["Payload Too Large"], requests, client)
@@ -167,13 +169,13 @@ module Puma
     #   a call to `Server#lowlevel_error`
     # @param requests [Integer] number of inline requests handled
     # @param client [Puma::Client]
-    # @return [Boolean,:async] keep-alive status or `:async`
+    # @return [:close, :keep_alive, :async]
     def prepare_response(status, headers, res_body, requests, client)
       env = client.env
       socket = client.io
       io_buffer = client.io_buffer
 
-      return false if closed_socket?(socket)
+      return :close if closed_socket?(socket)
 
       # Close the connection after a reasonable number of inline requests
       force_keep_alive = @enable_keep_alives && client.requests_served < @max_keep_alive
@@ -244,7 +246,7 @@ module Puma
           io_buffer << LINE_END
           fast_write_str socket, io_buffer.read_and_reset
           socket.flush
-          return keep_alive
+          return keep_alive ? :keep_alive : :close
         end
       else
         if content_length
@@ -270,7 +272,7 @@ module Puma
       fast_write_response socket, body, io_buffer, chunked, content_length.to_i
       body.close if close_body
       # if we're shutting down, close keep_alive connections
-      !shutting_down? && keep_alive
+      !shutting_down? && keep_alive ? :keep_alive : :close
     end
 
     HTTP_ON_VALUES = { "on" => true, HTTPS => true }

data/lib/puma/runner.rb

@@ -70,7 +70,7 @@ module Puma
         token = nil if token.empty? || token == 'none'
       end
 
-      app = Puma::App::Status.new @launcher, token
+      app = Puma::App::Status.new @launcher, token: token, data_only: @options[:control_data_only]
 
       # A Reactor is not created and nio4r is not loaded when 'queue_requests: false'
       # Use `nil` for events, no hooks in control server

data/lib/puma/server.rb

@@ -299,7 +299,7 @@ module Puma
     # If read buffering is not done, and no other read buffering is performed (such as by an application server
     # such as nginx) then the application would be subject to a slow client attack.
     #
-    # For a graphical representation of how the request buffer works see [architecture.md](https://github.com/puma/puma/blob/master/docs/architecture.md#connection-pipeline).
+    # For a graphical representation of how the request buffer works see [architecture.md](https://github.com/puma/puma/blob/main/docs/architecture.md).
     #
     # The method checks to see if it has the full header and body with
     # the `Puma::Client#try_to_finish` method. If the full request has been sent,
@@ -501,10 +501,10 @@ module Puma
           can_loop = false
           @requests_count += 1
           case handle_request(client, requests + 1)
-          when false
+          when :close
           when :async
             close_socket = false
-          when true
+          when :keep_alive
             requests += 1
 
             client.reset

data/lib/puma/single.rb

@@ -49,8 +49,8 @@ module Puma
 
       start_control
 
-      @server = server = start_server
-      server_thread = server.run
+      @server = start_server
+      server_thread = @server.run
 
       log "Use Ctrl-C to stop"
 

data/tools/Dockerfile

@@ -1,18 +1,26 @@
 # Use this Dockerfile to create minimal reproductions of issues
+# Build (MRI): docker build -f tools/Dockerfile .
+# Build (JRuby): docker build -f tools/Dockerfile --build-arg RUBY_IMAGE=jruby:9.4 .
 
-FROM ruby:3.2
+ARG RUBY_IMAGE=ruby:latest
+FROM ${RUBY_IMAGE}
 
-RUN apt-get update && apt-get install -y ragel
+# Set BUNDLE_FROZEN=false if you need to update Gemfile.lock during a build.
+ARG BUNDLE_FROZEN=true
 
-# throw errors if Gemfile has been modified since Gemfile.lock
-RUN bundle config --global frozen 1
+RUN apt-get update \
+  && apt-get install -y --no-install-recommends ragel procps git \
+  && rm -rf /var/lib/apt/lists/*
+
+# Only freeze Bundler and compile native extensions when using MRI.
+RUN if [ "$(ruby -e 'print RUBY_ENGINE')" = "ruby" ] && [ "${BUNDLE_FROZEN}" = "true" ]; then bundle config --global frozen 1; fi
 
 WORKDIR /usr/src/app
 
 COPY . .
 
 RUN bundle install
-RUN bundle exec rake compile
+RUN if [ "$(ruby -e 'print RUBY_ENGINE')" = "ruby" ]; then bundle exec rake compile; fi
 
 EXPOSE 9292
 CMD ["bundle", "exec", "bin/puma", "test/rackup/hello.ru"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: puma
 version: !ruby/object:Gem::Version
-  version: 7.1.0
+  version: 7.2.1
 platform: ruby
 authors:
 - Evan Phoenix
@@ -66,7 +66,6 @@ files:
 - docs/testing_benchmarks_local_files.md
 - docs/testing_test_rackup_ci_files.md
 - ext/puma_http11/PumaHttp11Service.java
-- ext/puma_http11/ext_help.h
 - ext/puma_http11/extconf.rb
 - ext/puma_http11/http11_parser.c
 - ext/puma_http11/http11_parser.h
@@ -128,7 +127,7 @@ licenses:
 - BSD-3-Clause
 metadata:
   bug_tracker_uri: https://github.com/puma/puma/issues
-  changelog_uri: https://github.com/puma/puma/blob/master/History.md
+  changelog_uri: https://github.com/puma/puma/blob/main/History.md
   homepage_uri: https://puma.io
   source_code_uri: https://github.com/puma/puma
   rubygems_mfa_required: 'true'
@@ -147,7 +146,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.6
 specification_version: 4
 summary: A Ruby/Rack web server built for parallelism.
 test_files: []

data/ext/puma_http11/ext_help.h

@@ -1,15 +0,0 @@
-#ifndef ext_help_h
-#define ext_help_h
-
-#define RAISE_NOT_NULL(T) if(T == NULL) rb_raise(rb_eArgError, "%s", "NULL found for " # T " when shouldn't be.");
-#define DATA_GET(from,type,data_type,name) TypedData_Get_Struct(from,type,data_type,name); RAISE_NOT_NULL(name);
-#define REQUIRE_TYPE(V, T) if(TYPE(V) != T) rb_raise(rb_eTypeError, "%s", "Wrong argument type for " # V " required " # T);
-#define ARRAY_SIZE(x) (sizeof(x)/sizeof(x[0]))
-
-#ifdef DEBUG
-#define TRACE()  fprintf(stderr, "> %s:%d:%s\n", __FILE__, __LINE__, __FUNCTION__)
-#else
-#define TRACE() 
-#endif
-
-#endif