Merge remote-tracking branch 'upstream/master' into jakarta-update

chadlwilson · chadlwilson · commit f9978fe3e98a · 2025-10-11T14:01:51.000+08:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -26,7 +26,10 @@
 ## 1.2.6 (UNRELEASED)
 
 - Add missing block-only signature for debug logging
-- update (bundled) rack to 2.2.19
+- update (bundled) rack to 2.2.20
+- Ensure rack boot process leaves ENV['GEM_PATH'] and Gem.paths in a consistent state
+- Remove undocumented and unsafe jruby.rack.env.gem_path = false option (unusable on Bundler 1.6+)
+- Fix unintended Rubygems initialization too early in boot process with JRuby 9.4+
 
 ## 1.2.5
 
diff --git a/Gemfile b/Gemfile
@@ -4,7 +4,7 @@ group :default do
   if rack_version = ENV['RACK_VERSION']
     gem 'rack', rack_version
   else
-    gem 'rack', '~> 2.2.18'
+    gem 'rack', '~> 2.2.20'
   end
 end
 
diff --git a/Gemfile.lock b/Gemfile.lock
@@ -6,7 +6,7 @@ GEM
       rake
       thor (>= 0.14.0)
     diff-lcs (1.6.2)
-    rack (2.2.18)
+    rack (2.2.20)
     rake (13.3.0)
     rspec (3.13.1)
       rspec-core (~> 3.13.0)
@@ -33,6 +33,6 @@ PLATFORMS
 
 DEPENDENCIES
   appraisal
-  rack (~> 2.2.18)
+  rack (~> 2.2.20)
   rake (~> 13.3)
   rspec
diff --git a/README.md b/README.md
@@ -1,8 +1,10 @@
 # JRuby-Rack
 
-[![Gem Version](https://badge.fury.io/rb/jruby-rack.png)][5]
-[![Build Status](https://github.com/jruby/jruby-rack/actions/workflows/maven.yml/badge.svg)][6]
-
+[![Gem Version](https://img.shields.io/gem/v/jruby-rack)](https://rubygems.org/gems/jruby-rack)
+[![Jar Version](https://img.shields.io/maven-central/v/org.jruby.rack/jruby-rack)](https://central.sonatype.com/artifact/org.jruby.rack/jruby-rack)
+[![master Build Status](https://github.com/jruby/jruby-rack/actions/workflows/maven.yml/badge.svg)](https://github.com/jruby/jruby-rack/actions/workflows/maven.yml?query=branch%3Amaster) (master)
+[![1.2.x Build Status](https://github.com/jruby/jruby-rack/actions/workflows/maven.yml/badge.svg?branch=1.2-stable)](https://github.com/jruby/jruby-rack/actions/workflows/maven.yml?query=branch%3A1.2-stable) (1.2.x)
+ 
 JRuby-Rack is a lightweight adapter for the Java Servlet environment that allows
 any (Ruby) Rack-based application to run unmodified in a Java Servlet container.
 JRuby-Rack supports Rails as well as any Rack-compatible Ruby web framework.
@@ -231,7 +233,13 @@ as context init parameters in web.xml or as VM-wide system properties.
   this option to en empty string (or 'false') it acts as if the ENV hash was
   cleared out (similar to the now removed `jruby.rack.ignore.env` option).
 - `jruby.runtime.env.rubyopt`: Set to true to cause ENV['RUBYOPT']
-  to be retained even when using `jruby.runtime.env` to override environemnt (similar to how the removed `jruby.rack.ignore.env` option behaved by default).
+  to be retained even when using `jruby.runtime.env` to override the environment.
+- `jruby.rack.env.gem_path`: If set to `true` (the default) jruby-rack will
+  ensure ENV['GEM_PATH'] is altered to include the `gem.path` above. If you set it to a
+  value, this value will be used as GEM_PATH, overriding the environment and
+  ignoring `gem.path` etc. By setting this option to en empty string the ENV['GEM_PATH'] will
+  not be modified by jruby-rack at all and will retain its original values implied by
+  the process environment and `jruby.runtime.env` setting.
 - `jruby.rack.logging`: Specify the logging device to use. Defaults to
   `servlet_context`. See below.
 - `jruby.rack.request.size.initial.bytes`: Initial size for request body memory
@@ -356,9 +364,7 @@ package and push the .jar every time a commit changes a source file).
 Please use [github][3] to file bugs, patches and/or pull requests.
 More information at the [wiki][4] or ask us at **#jruby**'s IRC channel.
 
-[1]: https://github.com/jruby/warbler#warbler--
+[1]: https://github.com/jruby/warbler
 [2]: https://central.sonatype.com/artifact/org.jruby.rack/jruby-rack
 [3]: https://github.com/jruby/jruby-rack/issues
 [4]: https://github.com/jruby/jruby-rack/wiki
-[5]: http://badge.fury.io/rb/jruby-rack
-[6]: https://github.com/jruby/jruby-rack/actions/workflows/maven.yml
diff --git a/examples/camping/Gemfile b/examples/camping/Gemfile
@@ -2,7 +2,7 @@ source 'https://rubygems.org'
 
 ruby '~> 3.1.0'
 
-gem 'rack', '~> 2.2.18'
+gem 'rack', '~> 2.2.20'
 gem 'rackup'
 gem 'camping', '< 3'
 gem 'markaby'
diff --git a/examples/camping/Gemfile.lock b/examples/camping/Gemfile.lock
@@ -24,13 +24,13 @@ GEM
     markaby (0.9.4)
       builder
     ostruct (0.6.2)
-    rack (2.2.18)
+    rack (2.2.20)
     rackup (1.0.1)
       rack (< 3)
       webrick
     rake (13.3.0)
-    rexml (3.4.3)
-    rubyzip (3.1.0)
+    rexml (3.4.4)
+    rubyzip (3.1.1)
     webrick (1.9.1)
 
 PLATFORMS
@@ -41,7 +41,7 @@ DEPENDENCIES
   camping (< 3)
   jruby-jars (< 10)
   markaby
-  rack (~> 2.2.18)
+  rack (~> 2.2.20)
   rackup
   warbler!
 
diff --git a/examples/rails7/Gemfile b/examples/rails7/Gemfile
@@ -3,7 +3,7 @@ source 'https://rubygems.org'
 ruby '~> 3.1.0'
 
 gem 'rails', '~> 7.2.2', '>= 7.2.2.2'
-gem 'rack', '~> 2.2.18'
+gem 'rack', '~> 2.2.20'
 gem "sprockets-rails"
 
 group :development do
diff --git a/examples/rails7/Gemfile.lock b/examples/rails7/Gemfile.lock
@@ -87,21 +87,27 @@ GEM
       tzinfo (~> 2.0, >= 2.0.5)
     base64 (0.3.0)
     benchmark (0.4.1)
-    bigdecimal (3.2.3-java)
+    bigdecimal (3.3.0)
+    bigdecimal (3.3.0-java)
     builder (3.3.0)
+    cgi (0.5.0)
     cgi (0.5.0-java)
     concurrent-ruby (1.3.5)
     connection_pool (2.5.4)
     crass (1.0.6)
+    date (3.4.1)
     date (3.4.1-java)
     drb (2.2.3)
+    erb (4.0.4)
+      cgi (>= 0.3.3)
     erb (4.0.4-java)
       cgi (>= 0.3.3)
     erubi (1.13.1)
-    globalid (1.2.1)
+    globalid (1.3.0)
       activesupport (>= 6.1)
     i18n (1.14.7)
       concurrent-ruby (~> 1.0)
+    io-console (0.8.1)
     io-console (0.8.1-java)
     irb (1.15.2)
       pp (>= 0.6.0)
@@ -119,10 +125,10 @@ GEM
       net-imap
       net-pop
       net-smtp
-    marcel (1.0.4)
+    marcel (1.1.0)
     mini_mime (1.1.5)
     minitest (5.25.5)
-    net-imap (0.5.10)
+    net-imap (0.5.12)
       date
       net-protocol
     net-pop (0.1.2)
@@ -131,18 +137,25 @@ GEM
       timeout
     net-smtp (0.5.1)
       net-protocol
+    nio4r (2.7.4)
     nio4r (2.7.4-java)
-    nokogiri (1.18.9-java)
+    nokogiri (1.18.10-java)
+      racc (~> 1.4)
+    nokogiri (1.18.10-x86_64-linux-gnu)
       racc (~> 1.4)
     ostruct (0.6.2)
-    pp (0.6.2)
+    pp (0.6.3)
       prettyprint
     prettyprint (0.2.0)
+    psych (5.2.6)
+      date
+      stringio
     psych (5.2.6-java)
       date
       jar-dependencies (>= 0.1.7)
+    racc (1.8.1)
     racc (1.8.1-java)
-    rack (2.2.18)
+    rack (2.2.20)
     rack-session (1.0.2)
       rack (< 3)
     rack-test (2.2.0)
@@ -180,9 +193,10 @@ GEM
       thor (~> 1.0, >= 1.2.2)
       zeitwerk (~> 2.6)
     rake (13.3.0)
-    rdoc (6.14.2)
+    rdoc (6.15.0)
       erb
       psych (>= 4.0.0)
+      tsort
     reline (0.6.2)
       io-console (~> 0.5)
     rexml (3.4.4)
@@ -196,12 +210,17 @@ GEM
       actionpack (>= 6.1)
       activesupport (>= 6.1)
       sprockets (>= 3.0.0)
+    stringio (3.1.7)
     thor (1.4.0)
     timeout (0.4.3)
+    tsort (0.2.0)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     useragent (0.16.11)
     webrick (1.9.1)
+    websocket-driver (0.8.0)
+      base64
+      websocket-extensions (>= 0.1.0)
     websocket-driver (0.8.0-java)
       base64
       websocket-extensions (>= 0.1.0)
@@ -210,10 +229,11 @@ GEM
 
 PLATFORMS
   universal-java-21
+  x86_64-linux
 
 DEPENDENCIES
   jruby-jars (< 10)
-  rack (~> 2.2.18)
+  rack (~> 2.2.20)
   rails (~> 7.2.2, >= 7.2.2.2)
   sprockets-rails
   warbler!
diff --git a/examples/sinatra/Gemfile b/examples/sinatra/Gemfile
@@ -4,7 +4,7 @@ ruby '~> 3.1.0'
 
 gem 'sinatra'
 gem 'webrick'
-gem 'rack', '~> 2.2.0'
+gem 'rack', '~> 2.2.20'
 
 group :development do
   gem 'warbler', github: 'jruby/warbler', branch: 'master'
diff --git a/examples/sinatra/Gemfile.lock b/examples/sinatra/Gemfile.lock
@@ -20,7 +20,7 @@ GEM
     mustermann (3.0.4)
       ruby2_keywords (~> 0.0.1)
     ostruct (0.6.2)
-    rack (2.2.18)
+    rack (2.2.20)
     rack-protection (3.2.0)
       base64 (>= 0.1.0)
       rack (~> 2.2, >= 2.2.4)
@@ -42,7 +42,7 @@ PLATFORMS
 
 DEPENDENCIES
   jruby-jars (< 10)
-  rack (~> 2.2.0)
+  rack (~> 2.2.20)
   sinatra
   warbler!
   webrick
diff --git a/src/main/ruby/jruby/rack.rb b/src/main/ruby/jruby/rack.rb
@@ -60,7 +60,6 @@ def logdev; ServletLog.new(context) end
   end
 end
 
-# TODO remove require 'jruby/rack/version' from jruby-rack in 1.2
 require 'jruby/rack/version' unless defined? JRuby::Rack::VERSION
 require 'jruby/rack/helpers'
 require 'jruby/rack/booter'
diff --git a/src/main/ruby/jruby/rack/booter.rb b/src/main/ruby/jruby/rack/booter.rb
@@ -98,53 +98,45 @@ def boot!
     protected
 
     def adjust_gem_path
-      gem_path = self.gem_path
+      desired_gem_path = self.gem_path
+
       case set_gem_path = env_gem_path
-      when true then
-        if env_path = ENV['GEM_PATH']
-          if gem_path.nil? || gem_path.empty?
-            return # keep ENV['GEM_PATH'] as is
-          elsif env_path != gem_path
-            separator = File::PATH_SEPARATOR
-            unless env_path.split(separator).include?(gem_path)
-              ENV['GEM_PATH'] = "#{gem_path}#{separator}#{env_path}"
-            end
-          end
-        else
-          ENV['GEM_PATH'] = gem_path
-        end
-      when false then
-        begin
-          require 'rubygems' unless defined? Gem.path
-        rescue LoadError
+      when true then # default behaviour
+        if (current_env_gem_path = ENV['GEM_PATH'])
+          # keep ENV['GEM_PATH'] as is if we have nothing to do
+          return if desired_gem_path.nil? || desired_gem_path.empty?
+          return if current_env_gem_path == desired_gem_path
+          return if current_env_gem_path.split(File::PATH_SEPARATOR).include?(desired_gem_path)
+
+          # need to prepend it
+          ENV['GEM_PATH'] = "#{desired_gem_path}#{File::PATH_SEPARATOR}#{current_env_gem_path}"
         else
-          return if gem_path.nil? || gem_path.empty?
-          Gem.path.unshift(gem_path) unless Gem.path.include?(gem_path)
+          ENV['GEM_PATH'] = desired_gem_path
         end
-        return false
-      when nil then # org.jruby.rack.RackLogger::DEBUG
-        if gem_path && ! gem_path.empty? &&
-          ( ! defined?(Gem.path) || ! Gem.path.include?(gem_path) )
-          @rack_context.log("Gem.path won't be updated although seems configured: #{gem_path}")
+      when nil then
+        if desired_gem_path && !desired_gem_path.empty? && (!defined?(Gem.path) || !Gem.path.include?(desired_gem_path) )
+          @rack_context.log("Gem.path won't be updated although seems configured: #{desired_gem_path}")
         end
-        return nil
-      else # 'jruby.rack.env.gem_path' "forced" to an explicit value
+        return nil # do nothing to ENV['GEM_PATH']
+      else # "forced" to an explicit value
         ENV['GEM_PATH'] = set_gem_path
       end
+      # Whenever we touch ENV['GEM_PATH`], ensure we clear any cached paths. All other cases should exit early.
+      Gem.clear_paths if defined?(Gem.clear_paths)
     end
 
-    # @return whether to update Gem.path and/or the environment GEM_PATH
-    # - true (default) forces ENV['GEM_PATH'] to be updated due compatibility
-    #   Bundler 1.6 fails to revolve gems correctly when Gem.path is updated
-    #   instead of the ENV['GEM_PATH'] environment variable
-    # - false disables ENV['GEM_PATH'] mangling for good (updates Gem.path)
+    # @return whether to update the environment GEM_PATH
+    # - true (default) forces ENV['GEM_PATH'] to be updated to include the `gem.path` above.
+    #   If you set it to a non-empty value, GEM_PATH will be forced to an explicit value,
+    #   overriding the environment and ignoring `gem.path`, `gem.home` etc.
     #
-    # - if not specified Gem.path will be updated based on setting
+    # - By setting this option to an empty string the ENV['GEM_PATH'] should not be modified
+    #   at all and will retain its original values implied by the process environment and
+    #  `jruby.runtime.env` setting.
     def env_gem_path
       gem_path = @rack_context.getInitParameter('jruby.rack.env.gem_path')
       return true if gem_path.nil? || gem_path.to_s == 'true'
-      return false if gem_path.to_s == 'false'
-      return nil if gem_path.empty? # set to an empty disables mangling
+      return nil if gem_path.empty? || gem_path.to_s == 'false' # treat false as "don't touch either ENV or Gem.path"
       gem_path
     end
     private :env_gem_path
diff --git a/src/main/ruby/jruby/rack/capture.rb b/src/main/ruby/jruby/rack/capture.rb
@@ -5,13 +5,11 @@
 # See the file LICENSE.txt for details.
 #++
 
-require 'stringio'
-
 module JRuby::Rack
   module Capture
     module Base
       def output
-        @output ||= begin; StringIO.new; end
+        @output ||= begin; require 'stringio' unless defined?(StringIO); StringIO.new; end
       end
 
       def capture
@@ -34,6 +32,7 @@ def store
     module Exception
       def output
         @output ||= begin
+          require 'stringio' unless defined?(StringIO)
           io = StringIO.new
           io.puts "An exception happened during JRuby-Rack startup", self.to_s
           io
diff --git a/src/spec/ruby/jruby/rack/booter_spec.rb b/src/spec/ruby/jruby/rack/booter_spec.rb
diff --git a/src/spec/ruby/jruby/rack/rails_booter_spec.rb b/src/spec/ruby/jruby/rack/rails_booter_spec.rb
