Merge remote-tracking branch 'upstream/master' into gocd-master

Author: chadlwilson

.github/workflows/maven.yml

@@ -10,16 +10,18 @@ env:
   # Default versions for canonical release build
   DEFAULT_JAVA_VERSION: '8'
   DEFAULT_JRUBY_VERSION: '9.4.13.0' # Should match pom.xml <jruby.version> property (AND a version inside the test matrix)
+  DEFAULT_RACK_VERSION: '~> 2.2.0' # Should match Gemfile (AND a version inside the test matrix)
 
 jobs:
   build:
-    name: JRuby ${{ matrix.jruby_version }} / Java ${{ matrix.java_version }}
+    name: Rack ${{ matrix.rack_version }} on JRuby ${{ matrix.jruby_version }} / Java ${{ matrix.java_version }}
     runs-on: ubuntu-latest
 
     strategy:
       matrix:
         jruby_version: [ '9.4.13.0', '10.0.2.0' ]
         java_version: [ '8', '11', '17', '21' ]
+        rack_version: [ '~> 2.2.0' ]
         exclude:
           - jruby_version: '10.0.2.0'
             java_version: '8'  # JRuby 10 requires Java 21
@@ -41,31 +43,42 @@ jobs:
 
     - name: Build with Maven
       run: ./mvnw -B install -Djruby.version=${{ matrix.jruby_version }}
+      env:
+        RACK_VERSION: ${{ matrix.rack_version }}
 
     # Uploads the full dependency graph to GitHub to improve the quality of Dependabot alerts this repository can receive
     - name: Update dependency graph
       uses: advanced-security/maven-dependency-submission-action@b275d12641ac2d2108b2cbb7598b154ad2f2cee8 # v5.0.0
-      if: github.ref == 'refs/heads/master' && matrix.java_version == env.DEFAULT_JAVA_VERSION && matrix.jruby_version == env.DEFAULT_JRUBY_VERSION
+      if: github.ref == 'refs/heads/master' && matrix.java_version == env.DEFAULT_JAVA_VERSION && matrix.jruby_version == env.DEFAULT_JRUBY_VERSION && matrix.rack_version == env.DEFAULT_RACK_VERSION
 
   appraisals:
     needs: build
-    name: ${{ matrix.appraisal }} appraisal on ${{ matrix.jruby_version }} / Java ${{ matrix.java_version }}
+    name: ${{ matrix.appraisal }} on ${{ matrix.jruby_version }} / Java ${{ matrix.java_version }}
     runs-on: ubuntu-latest
 
     strategy:
       matrix:
+        appraisal: [
+          'rails50_rack22',
+          'rails52_rack22',
+          'rails60_rack22',
+          'rails61_rack22',
+          'rails70_rack22',
+          'rails71_rack22',
+          'rails72_rack22',
+          'rails80_rack22',
+        ]
         jruby_version: [ '9.4.13.0', '10.0.2.0' ]
         java_version: [ '8', '11', '17', '21' ]
-        appraisal: [ 'rails50', 'rails52', 'rails60', 'rails61', 'rails70', 'rails71', 'rails72', 'rails80' ]
         exclude:
-          - jruby_version: '9.4.13.0'
-            appraisal: 'rails80' # Requires Ruby 3.4 compatibility, which JRuby 9.4 does not support
           - jruby_version: '10.0.2.0'
             java_version: '8'  # JRuby 10 requires Java 21
           - jruby_version: '10.0.2.0'
             java_version: '11' # JRuby 10 requires Java 21
           - jruby_version: '10.0.2.0'
             java_version: '17' # JRuby 10 requires Java 21
+          - appraisal: 'rails80_rack22'
+            jruby_version: '9.4.13.0' # Rails 8 requires Ruby 3.4 compatibility, which JRuby 9.4 does not support
       fail-fast: false
 
     env:

.gitignore

@@ -12,3 +12,4 @@ examples/*/nbproject
 nbproject
 .idea/
 .rvmrc
+gemfiles/*.lock

Appraisals

@@ -1,31 +1,24 @@
-appraise "rails50" do
-  gem "rails", "~> 5.0.0"
-end
-
-appraise "rails52" do
-  gem "rails", "~> 5.2.0"
-end
+version_spec = ->(prefix, desc) { "~> #{desc.split(prefix).last.insert(1, ".")}.0" }
 
-appraise "rails60" do
-  gem "rails", "~> 6.0.0"
-end
-
-appraise "rails61" do
-  gem "rails", "~> 6.1.0"
-end
+# Rails version -> rack versions in format
+# rails#{MAJOR}#{MINOR} => %w[ rack#{MAJOR}#{MINOR} ]
+{
+    "rails50" => %w[rack22],
+    "rails52" => %w[rack22],
+    "rails60" => %w[rack22],
+    "rails61" => %w[rack22],
+    "rails70" => %w[rack22],
+    "rails71" => %w[rack22],
+    "rails72" => %w[rack22],
+    "rails80" => %w[rack22]
+}.each do |rails_desc, rack_descs|
+  rack_descs.each do |rack_desc|
 
-appraise "rails70" do
-  gem "rails", "~> 7.0.0"
+    appraise "#{rails_desc}_#{rack_desc}" do
+      group :default do
+        gem "rack", version_spec.call("rack", rack_desc)
+        gem "rails", version_spec.call("rails", rails_desc)
+      end
+    end
+  end
 end
-
-appraise "rails71" do
-  gem "rails", "~> 7.1.0"
-end
-
-appraise "rails72" do
-  gem "rails", "~> 7.2.0"
-end
-
-appraise "rails80" do
-  gem "rails", "~> 8.0.0"
-end

Gemfile

@@ -4,7 +4,7 @@ group :default do
   if rack_version = ENV['RACK_VERSION']
     gem 'rack', rack_version
   else
-    gem 'rack', '~> 2.2'
+    gem 'rack', '~> 2.2.0'
   end
 end
 

Gemfile.lock

@@ -20,7 +20,7 @@ GEM
     rspec-mocks (3.13.5)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-support (3.13.4)
+    rspec-support (3.13.5)
     thor (1.4.0)
 
 PLATFORMS
@@ -32,6 +32,6 @@ PLATFORMS
 
 DEPENDENCIES
   appraisal
-  rack (~> 2.2)
+  rack (~> 2.2.0)
   rake (~> 13.3)
   rspec

History.md

@@ -6,13 +6,19 @@
 - Drop unnecessary `jruby.compat.version` and `RackConfig.getCompatVersion()` API
 - Drop JMS support
 - Drop deprecated `RackLogger` string (level) constants
-- Drop `jruby.rack.jruby.version` and `jruby.rack.rack.release` keys from rack `env` Hhsh
+- Drop `jruby.rack.jruby.version` and `jruby.rack.rack.release` keys from rack `env` Hash
+- Drop deprecated `Rack::Handler::Servlet::Env` and `Rack::Handler::Servlet::LazyEnv` types (replaced by `DefaultEnv`)
+- Drop undocumented and deprecated jruby-rack 1.0 backwards compat properties `jruby.runtime.timeout.sec`, `jruby.runtime.initializer.threads`, `jruby.init.serial`, `jruby.rack.request.size.threshold.bytes`
+- Drop deprecated `jruby.rack.ignore.env` property, replaced long ago by `jruby.runtime.env` and optional `jruby.runtime.env.rubyopt`
+- Drop deprecated `jruby.rack.filter.*` properties, replaced long ago by init parameters `addsHtmlToPathInfo` and `verifiesHtmlResource`
+- Drop deprecated `JRuby::Rack::RailsFileSystemLayout` alias for `JRuby::Rack::FileSystemLayout`
+- Drop deprecated `JRuby::Rack::Errors` alias for `JRuby::Rack::ErrorApp`
+- Drop deprecated `org.jruby.rack.RackInput` alias for `org.jruby.rack.ext.Input` class
+- Drop/rename deprecated `RackConfig` and `ServletRackEnvironment` API methods per their earlier comments
 - Change context listener to throw, in case of an exception during initialization, by default
 - Change rails context listener to assume a thread-safe application by default
-- update (bundled) rack to 2.2.17
-- Fix Rails 7.1 CSRF protection when working with `JavaServletStore` sessions
 
-## 1.2.4 (UNRELEASED)
+## 1.2.4
 
 - update (bundled) rack to 2.2.17
 - Fix Rails 7.1 CSRF protection when working with `JavaServletStore` sessions
@@ -173,9 +179,9 @@ Changes from 1.1.15 apply since the previous release got yanked due a regression
   to handle custom lazy-bound keys but can not use a default proc (#132)
 - support the renew (and skip) session option with servlet store (#131)
 - improve ENV isolation with booted Ruby runtimes
-  * jruby.rack.env replaces jruby.rack.ignore.env (now deprecated)
+  * jruby.runtime.env replaces jruby.rack.ignore.env (now deprecated)
   * make sure RUBYOPT is ignored (with backwards compat)
-  * jruby.rack.env.rubyopt for finer RUBYOPT behavior control
+  * jruby.runtime.env.rubyopt for finer RUBYOPT behavior control
   * allow env value to be specified from config
 - solve the rackup "chicken - egg" problem with a plain Rack app
   * with a magic comment in config.ru # rack.version: ~>1.3.6

README.md

@@ -1,7 +1,7 @@
 # JRuby-Rack
 
-[![Gem Version](https://badge.fury.io/rb/jruby-rack.png)][8]
-[![Build Status](https://github.com/jruby/jruby-rack/actions/workflows/maven.yml/badge.svg)][9]
+[![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]
 
 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.
@@ -28,12 +28,13 @@ dependencies {
 
 ## Compatibility
 
-| JRuby-Rack Version                                           | Status     | Rack      | JRuby      | Java    | Target Servlet API | Target Java EE | Notes                                      |
-|--------------------------------------------------------------|------------|-----------|------------|---------|--------------------|----------------|--------------------------------------------|
-| 2.0.x (_planned_)                                            | Dev        | 2.2       | 9.4 → 10.0 | Java 8+ | 5.0+               | Jakarta EE 9   | Pre 5.0 servlet APIs non functional.       |
-| 1.3.x (master, _unreleased_)                                 | Dev        | 2.2       | 9.4 → 10.0 | Java 8+ | 4.0                | Java EE 8      | Servlet 2.5 → 3.1 likely to work fine.     |
-| [1.2.x](https://github.com/jruby/jruby-rack/tree/1.2-stable) | Maintained | 2.2       | 9.3 → 9.4  | Java 8+ | 3.0                | Java EE 6      | Servlet 3.1 → 4.0 OK with some containers. |
-| [1.1.x](https://github.com/jruby/jruby-rack/tree/1.1-stable) | EOL        | 1.x → 2.2 | 1.6 → 9.4  | Java 8+ | 2.5                | Java EE 5      | Servlet 3.0 → 4.0 OK with some containers. |
+| JRuby-Rack Series                                          | Status     | Rack      | JRuby      | Java | Rails     | Target Servlet API  | Notes                                      |
+|------------------------------------------------------------|------------|-----------|------------|------|-----------|---------------------|--------------------------------------------|
+| 2.0 (_planned_)                                            | Dev        | 2.2       | 9.4 → 10.0 | 8+   | 5.0 → 8.0 | 5.0+ (Jakarta EE 9) | Pre 5.0 servlet APIs non functional.       |
+| 1.3 (master, _unreleased_)                                 | Dev        | 2.2       | 9.4 → 10.0 | 8+   | 5.0 → 8.0 | 4.0 (Java EE 8)     | Servlet 2.5 → 3.1 likely to work fine.     |
+| [1.2](https://github.com/jruby/jruby-rack/tree/1.2-stable) | Maintained | 2.2       | 9.3 → 9.4  | 8+   | 5.0 → 7.2 | 3.0 (Java EE 6)     | Servlet 3.1 → 4.0 OK with some containers. |
+| [1.1](https://github.com/jruby/jruby-rack/tree/1.1-stable) | EOL        | 1.x → 2.2 | 1.6 → 9.4  | 6+   | 2.1 → 5.2 | 2.5 (Java EE 5)     | Servlet 3.0 → 4.0 OK with some containers. |
+| 1.0                                                        | EOL        | 0.9 → 1.x | 1.1 → 1.9  | 5+   | 2.1 → 3.x | 2.5 (Java EE 5)     |                                            |
 
 ## Getting Started
 
@@ -52,9 +53,6 @@ Otherwise you'll need to download the latest [jar release][2], drop it into the
 *WEB-INF/lib* directory and configure the `RackFilter` in your application's
 *web.xml* (see following examples).
 
-Alternatively you can use a server built upon JRuby-Rack such as [Trinidad][3]
-with sensible defaults, without the need to configure a deployment descriptor.
-
 ### Rails
 
 Here's sample *web.xml* configuration for Rails. Note the environment and
@@ -161,9 +159,14 @@ using is `org.jruby.rack.RackFilter`, the filter supports the following
   gets reset (accepts  values "true", "false" and "buffer" to reset the buffer
   only), by default "true"
 - **addsHtmlToPathInfo** controls whether the .html suffix is added to the URI
-  when checking if the request is for a static page
+  when checking if the request is for a static page. The default behavior for 
+  Rails and many other Ruby applications is to add an *.html* extension to the 
+  resource and attempt to handle it before serving a dynamic request on the 
+  original URI.  However, this behavior may confuse other servlets in your 
+  application that have a wildcard mapping. Defaults to true.
 - **verifiesHtmlResource** used with the previous parameter to make sure the
-  requested static resource exists before adding the .html request URI suffix
+  requested static resource exists before adding the .html request URI suffix.
+  Defaults to false.
 
 The application can also be configured to dispatch through a servlet instead of
 a filter, the servlet class name is `org.jruby.rack.RackServlet`.
@@ -192,11 +195,11 @@ Several aspects of Rails are automatically set up for you.
 ## JRuby Runtime Management
 
 JRuby runtime management and pooling is done automatically by the framework.
-In the case of Rails, runtimes are pooled by default (the default will most
-likely change with the adoption of Rails 4.0). For other Rack applications a
-single shared runtime is created and shared for every request by default.
-As of **1.1.9** if *jruby.min.runtimes* and *jruby.max.runtimes* values are
-specified pooling is supported for plain Rack applications as well.
+For Rack-only applications (and Rails ones from jruby-rack >= 1.3), a single 
+shared runtime is created and shared for every request by default.
+
+If *jruby.min.runtimes* and *jruby.max.runtimes* values are
+specified pooling of runtimes can be enabled for both types of applications.
 
 We do recommend to boot your runtimes up-front to avoid the cost of initializing
 one while a request kicks in and find the pool empty, this can be easily avoided
@@ -241,10 +244,9 @@ as context init parameters in web.xml or as VM-wide system properties.
 - `jruby.runtime.env`: Allows to set a custom ENV hash for your Ruby environment
   and thus insulate the application from the environment it is running. By setting
   this option to en empty string (or 'false') it acts as if the ENV hash was
-  cleared out (similar to the now deprecated `jruby.rack.ignore.env` option).
-- `jruby.runtime.env.rubyopt`: This option is used for compatibility with the
-  (deprecated) `jruby.rack.ignore.env` option since it cleared out the ENV after
-  RUBYOPT has been processed, by setting it to true ENV['RUBYOPT'] will be kept.
+  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).
 - `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
@@ -263,20 +265,6 @@ as context init parameters in web.xml or as VM-wide system properties.
   been previously read this leads to a limitation (Rack won't see the POST paras).
   Thus an alternate pure 'servlet' env "conversion" is provided that maps servlet
   parameters (and cookies) directly to Rack params, avoiding Rack's input parsing.
-- `jruby.rack.filter.adds.html`:
-  **deprecated** use `addsHtmlToPathInfo` filter config init parameter.
-  The default behavior for Rails and many other Ruby applications is to add an
-  *.html* extension to the resource and attempt to handle it before serving a
-  dynamic request on the original URI.
-  However, this behavior may confuse other servlets in your application that
-  have a wildcard mapping. Defaults to true.
-- `jruby.rack.filter.verify.resource.exists`:
-  **deprecated** use `verifiesHtmlResource` filter config init parameter.
-  If `jruby.rack.filter.adds.html` is true, then this setting, when true, adds
-  an additional check using `ServletContext#getResource` to verify that the
-  *.html* resource exists. Default is false.
-  (Note that apparently some servers may not implement `getResource` in the way
-  that is expected here, so in that case this setting won't matter.)
 
 ## Initialization
 
@@ -331,17 +319,16 @@ For those loggers that require a specific named logger, set it with the
 Checkout the JRuby-Rack code using [git](http://git-scm.com/) :
 
 ```shell
-git clone git://github.com/jruby/jruby-rack.git
+git clone git@github.com:jruby/jruby-rack.git
 cd jruby-rack
 ```
 
-Ensure you have [Maven](http://maven.apache.org/) installed.
-It is required for downloading jar artifacts that JRuby-Rack depends on.
+Ensure you have a compatible JVM installed. It is required for building and compiling.
 
 Build the .jar using Maven :
 
 ```shell
-mvn install
+./mvnw install
 ```
 
 the generated jar should be located at **target/jruby-rack-*.jar**
@@ -359,21 +346,20 @@ package and push the .jar every time a commit changes a source file).
 
 ## Releasing
 
-* Make sure auth is configured for "central" repository ID in your .m2/settings.xml
-* Update the version in src/main/ruby/jruby/rack/version.rb to the release version
-* mvn release:prepare
-* mvn release:perform (possibly with -DuseReleaseProfile=false due to Javadoc doclint failures for now)
-* rake clean gem SKIP_SPECS=true and push the gem
+* Make sure auth is configured for "central" repository ID in your `.m2/settings.xml`
+* Update the version in `src/main/ruby/jruby/rack/version.rb` to the release version
+* `./mvnw release:prepare`
+* `./mvnw release:perform` (possibly with `-DuseReleaseProfile=false` due to Javadoc doclint failures for now)
+* `rake clean gem SKIP_SPECS=true` and push the gem
 
 ## Support
 
-Please use [github][4] to file bugs, patches and/or pull requests.
-More information at the [wiki][5] or ask us at **#jruby**'s IRC channel.
+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--
-[2]: https://oss.sonatype.org/content/repositories/releases/org/jruby/rack/jruby-rack/
-[3]: https://github.com/trinidad/trinidad
-[4]: https://github.com/jruby/jruby-rack/issues
-[5]: https://wiki.github.com/jruby/jruby-rack
-[8]: http://badge.fury.io/rb/jruby-rack
-[9]: https://github.com/jruby/jruby-rack/actions/workflows/maven.yml
+[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