puma 5.2.0 → 5.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a4d9b1bd7562eeb74d7f1045f732667a6b9ab3c9b51fa602c1679017b79450d6
-  data.tar.gz: d287f603974f6aaf5e16610ae5528c086595a1b1dc026343b7155443c2c0f10a
+  metadata.gz: d702fffe078664ed49a411a31910737455c819d6acadd3875c89e00368f68dd8
+  data.tar.gz: 972f53b07a05363ff839b6f176150bdf4cbc19f7445601ad10f41e9bcaf73af2
 SHA512:
-  metadata.gz: 6db9d8631ed272b1a405eec838414949314154f1e4d9cb95d825ec9a85ade7eaf66180771e89da58845089d824f34af53cd58c18b5bb85e12accb47184e1724c
-  data.tar.gz: 13c7da69b1dc0f25da9583baa0d235531ad67efe824f12decc9e6d65b3573bf193119d15f7800a5980cc1ca9d4e67cebb5ebf2d6d1abb4d95ca54e8ac653a327
+  metadata.gz: fff3451918f8e34324189c0fa6c161baa1860181920f934541a4db9b5e484d20edae74dd9ac33baa3c14514c75d052cbb5d42539f371bf33cca82e644aa52c57
+  data.tar.gz: 86c7ba8cb909bedb1dceb259d28677295a71e66b53ed1f1fb6ce324ddab0dbe05c5469aaa120f50f7427cc257d6fa6b6898c7b0346810871f1fceb2ad25bab93

data/History.md

@@ -1,3 +1,11 @@
+## 5.2.1 / 2021-02-05
+
+* Bugfixes
+  * Fix TCP cork/uncork operations to work with ssl clients ([#2550])
+  * Require rack/common_logger explicitly if :verbose is true ([#2547])
+  * MiniSSL::Socket#write - use data.byteslice(wrote..-1) ([#2543])
+  * Set `@env[CONTENT_LENGTH]` value as string. ([#2549])
+
 ## 5.2.0 / 2021-01-27
 
 * Features
@@ -1694,6 +1702,10 @@ 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)
 
+[#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"
+[#2549]:https://github.com/puma/puma/pull/2549     "PR by @nmb, merged 2021-02-04"
 [#2519]:https://github.com/puma/puma/pull/2519     "PR by @MSP-Greg, merged 2021-01-26"
 [#2522]:https://github.com/puma/puma/pull/2522     "PR by @jcmfernandes, merged 2021-01-12"
 [#2490]:https://github.com/puma/puma/pull/2490     "PR by @Bonias, merged 2020-12-07"

data/docs/rails_dev_mode.md

@@ -0,0 +1,29 @@
+# Running Puma in Rails Development Mode
+
+## "Loopback requests" 
+
+Be cautious of "loopback requests", where a Rails application executes a request to a server that in turn, results in another request back to the same Rails application before the first request is completed. Having a loopback request will trigger [Rails' load interlock](https://guides.rubyonrails.org/threading_and_code_execution.html#load-interlock) mechanism. The load interlock mechanism prevents a thread from using Rails autoloading mechanism to load constants while the application code is still running inside another thread.
+
+This issue only occurs in the development environment as Rails' load interlock is not used in production environments. Although we're not sure, we believe this issue may not occur with the new `zeitwerk` code loader.
+
+### Solutions
+
+
+#### 1. Bypass Rails' load interlock with `.permit_concurrent_loads`
+
+Wrap the first request inside a block that will allow concurrent loads, [`ActiveSupport::Dependencies.interlock.permit_concurrent_loads`](https://guides.rubyonrails.org/threading_and_code_execution.html#permit-concurrent-loads). Anything wrapped inside the `.permit_concurrent_loads` block will bypass the load interlock mechanism, allowing new threads to access the Rails environment and boot properly. 
+
+###### Example 
+
+```ruby
+response = ActiveSupport::Dependencies.interlock.permit_concurrent_loads do
+  # Your HTTP request code here. For example:
+  Faraday.post url, data: 'foo'
+end
+
+do_something_with response
+```
+
+####  2. Use multiple processes on Puma
+
+Alternatively, you may also enable multiple (single-threaded) workers on Puma. By doing so, you are sidestepping the problem by creating multiple processes rather than new threads. However, this workaround is not ideal because debugging tools such as [byebug](https://github.com/deivid-rodriguez/byebug/issues/487) and [pry](https://github.com/pry/pry/issues/2153), work poorly with any multi-process web server. 

data/lib/puma.rb

@@ -19,6 +19,24 @@ module Puma
   autoload :Server, 'puma/server'
   autoload :Launcher, 'puma/launcher'
 
+  # at present, MiniSSL::Engine is only defined in extension code (puma_http11),
+  # not in minissl.rb
+  HAS_SSL = const_defined?(:MiniSSL, false) && MiniSSL.const_defined?(:Engine, false)
+
+  if HAS_SSL
+    require 'puma/minissl'
+  else
+    module MiniSSL
+      # this class is defined so that it exists when Puma is compiled
+      # without ssl support, as Server and Reactor use it in rescue statements.
+      class SSLError < StandardError ; end
+    end
+  end
+
+  def self.ssl?
+    HAS_SSL
+  end
+
   # @!attribute [rw] stats_object=
   def self.stats_object=(val)
     @get_stats = val
@@ -40,12 +58,4 @@ module Puma
     return unless Thread.current.respond_to?(:name=)
     Thread.current.name = "puma #{name}"
   end
-
-  unless HAS_SSL
-    module MiniSSL
-      # this class is defined so that it exists when Puma is compiled
-      # without ssl support, as Server and Reactor use it in rescue statements.
-      class SSLError < StandardError ; end
-    end
-  end
 end

data/lib/puma/client.rb

@@ -374,7 +374,7 @@ module Puma
         end
 
         if decode_chunk(chunk)
-          @env[CONTENT_LENGTH] = @chunked_content_length
+          @env[CONTENT_LENGTH] = @chunked_content_length.to_s
           return true
         end
       end
@@ -391,7 +391,7 @@ module Puma
       @chunked_content_length = 0
 
       if decode_chunk(body)
-        @env[CONTENT_LENGTH] = @chunked_content_length
+        @env[CONTENT_LENGTH] = @chunked_content_length.to_s
         return true
       end
     end

data/lib/puma/const.rb

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

data/lib/puma/detect.rb

@@ -1,32 +1,36 @@
 # frozen_string_literal: true
 
+# This file can be loaded independently of puma.rb, so it cannot have any code
+# that assumes puma.rb is loaded.
+
+
 module Puma
-  # at present, MiniSSL::Engine is only defined in extension code, not in minissl.rb
-  HAS_SSL = const_defined?(:MiniSSL, false) && MiniSSL.const_defined?(:Engine, false)
+  # @version 5.2.1
+  HAS_FORK = ::Process.respond_to? :fork
 
-  def self.ssl?
-    HAS_SSL
-  end
+  IS_JRUBY = Object.const_defined? :JRUBY_VERSION
 
-  IS_JRUBY = defined?(JRUBY_VERSION)
+  IS_WINDOWS = !!(RUBY_PLATFORM =~ /mswin|ming|cygwin/ ||
+    IS_JRUBY && RUBY_DESCRIPTION =~ /mswin/)
+
+  # @version 5.2.0
+  IS_MRI = (RUBY_ENGINE == 'ruby' || RUBY_ENGINE.nil?)
 
   def self.jruby?
     IS_JRUBY
   end
 
-  IS_WINDOWS = RUBY_PLATFORM =~ /mswin|ming|cygwin/
-
   def self.windows?
     IS_WINDOWS
   end
 
   # @version 5.0.0
   def self.mri?
-    RUBY_ENGINE == 'ruby' || RUBY_ENGINE.nil?
+    IS_MRI
   end
 
   # @version 5.0.0
   def self.forkable?
-    ::Process.respond_to?(:fork)
+    HAS_FORK
   end
 end

data/lib/puma/minissl.rb

@@ -133,7 +133,7 @@ module Puma
 
           return data_size if need == 0
 
-          data = data[wrote..-1]
+          data = data.byteslice(wrote..-1)
         end
       end
 

data/lib/puma/request.rb

@@ -30,7 +30,7 @@ module Puma
     #
     def handle_request(client, lines)
       env = client.env
-      io = client.io
+      io  = client.io   # io may be a MiniSSL::Socket
 
       return false if closed_socket?(io)
 

data/lib/puma/server.rb

@@ -120,17 +120,13 @@ module Puma
       # :nodoc:
       # @version 5.0.0
       def tcp_cork_supported?
-        RbConfig::CONFIG['host_os'] =~ /linux/ &&
-          Socket.const_defined?(:IPPROTO_TCP) &&
-          Socket.const_defined?(:TCP_CORK)
+        Socket.const_defined?(:TCP_CORK) && Socket.const_defined?(:IPPROTO_TCP)
       end
 
       # :nodoc:
       # @version 5.0.0
       def closed_socket_supported?
-        RbConfig::CONFIG['host_os'] =~ /linux/ &&
-          Socket.const_defined?(:IPPROTO_TCP) &&
-          Socket.const_defined?(:TCP_INFO)
+        Socket.const_defined?(:TCP_INFO) && Socket.const_defined?(:IPPROTO_TCP)
       end
       private :tcp_cork_supported?
       private :closed_socket_supported?
@@ -138,6 +134,7 @@ module Puma
 
     # On Linux, use TCP_CORK to better control how the TCP stack
     # packetizes our stream. This improves both latency and throughput.
+    # socket parameter may be an MiniSSL::Socket, so use to_io
     #
     if tcp_cork_supported?
       UNPACK_TCP_STATE_FROM_TCP_INFO = "C".freeze
@@ -146,16 +143,18 @@ module Puma
       # 3 == TCP_CORK
       # 1/0 == turn on/off
       def cork_socket(socket)
+        skt = socket.to_io
         begin
-          socket.setsockopt(Socket::IPPROTO_TCP, Socket::TCP_CORK, 1) if socket.kind_of? TCPSocket
+          skt.setsockopt(Socket::IPPROTO_TCP, Socket::TCP_CORK, 1) if skt.kind_of? TCPSocket
         rescue IOError, SystemCallError
           Thread.current.purge_interrupt_queue if Thread.current.respond_to? :purge_interrupt_queue
         end
       end
 
       def uncork_socket(socket)
+        skt = socket.to_io
         begin
-          socket.setsockopt(Socket::IPPROTO_TCP, Socket::TCP_CORK, 0) if socket.kind_of? TCPSocket
+          skt.setsockopt(Socket::IPPROTO_TCP, Socket::TCP_CORK, 0) if skt.kind_of? TCPSocket
         rescue IOError, SystemCallError
           Thread.current.purge_interrupt_queue if Thread.current.respond_to? :purge_interrupt_queue
         end

data/lib/rack/handler/puma.rb

@@ -31,6 +31,7 @@ module Rack
 
         conf = ::Puma::Configuration.new(options, default_options) do |user_config, file_config, default_config|
           if options.delete(:Verbose)
+            require 'rack/common_logger'
             app = Rack::CommonLogger.new(app, STDOUT)
           end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puma
 version: !ruby/object:Gem::Version
-  version: 5.2.0
+  version: 5.2.1
 platform: ruby
 authors:
 - Evan Phoenix
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-01-27 00:00:00.000000000 Z
+date: 2021-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nio4r
@@ -57,6 +57,7 @@ files:
 - docs/kubernetes.md
 - docs/nginx.md
 - docs/plugins.md
+- docs/rails_dev_mode.md
 - docs/restart.md
 - docs/signals.md
 - docs/stats.md