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

# Conflicts:
#	src/main/java/org/jruby/rack/servlet/ResponseCapture.java
#	src/spec/java/org/jruby/rack/fake/FakePageContext.java
#	src/spec/java/org/jruby/rack/mock/RackLoggingMockServletContext.java

Author: chadlwilson

.github/dependabot.yml

@@ -3,7 +3,7 @@ updates:
   - package-ecosystem: github-actions
     directory: "/"
     schedule:
-      interval: monthly
+      interval: weekly
     groups:
       actions-deps:
         patterns: [ "*" ]
@@ -12,7 +12,7 @@ updates:
   - package-ecosystem: maven
     directory: "/"
     schedule:
-      interval: monthly
+      interval: weekly
     groups:
       maven-deps:
         dependency-type: "production"
@@ -30,9 +30,8 @@ updates:
   - package-ecosystem: bundler
     directories:
       - "/"
-      - "/examples/*"
     schedule:
-      interval: monthly
+      interval: weekly
     allow:
       - dependency-type: all
     groups:
@@ -41,19 +40,15 @@ updates:
     ignore:
       - dependency-name: "rack"
         update-types: [ "version-update:semver-major" ]
-      - dependency-name: "rails"
-        update-types: [ "version-update:semver-minor" ]
-      - dependency-name: "jruby-jars"
-        update-types: [ "version-update:semver-major" ]
 
-  # Maintabled stable branches
+  # Maintained stable branches
   - package-ecosystem: maven
     target-branch: "1.2-stable"
     commit-message:
       prefix: "1.2.x: "
     directory: "/"
     schedule:
-      interval: monthly
+      interval: weekly
     groups:
       maven-deps:
         dependency-type: "production"
@@ -74,9 +69,8 @@ updates:
       prefix: "1.2.x: "
     directories:
       - "/"
-      - "/examples/*"
     schedule:
-      interval: monthly
+      interval: weekly
     allow:
       - dependency-type: all
     groups:
@@ -85,8 +79,4 @@ updates:
     ignore:
       - dependency-name: "rack"
         update-types: [ "version-update:semver-major" ]
-      - dependency-name: "rails"
-        update-types: [ "version-update:semver-minor" ]
-      - dependency-name: "jruby-jars"
-        update-types: [ "version-update:semver-major" ]
 

.github/workflows/maven.yml

@@ -96,9 +96,12 @@ jobs:
         uses: ruby/setup-ruby@v1
         with:
           ruby-version: jruby-${{ matrix.jruby_version }}
-          bundler-cache: 'false' # Need to install later so we can vary from Gemfile.lock as required for JRuby version compatibility
+          bundler-cache: 'true'
           bundler: 'Gemfile.lock'
 
+      - name: Remove jruby-launcher # Coming from setup-ruby/ruby-build and causes annoying warnings
+        run: gem uninstall -a jruby-launcher
+
       - name: Run appraisal for ${{ matrix.appraisal }}
         run: bundle install && bundle exec rake spec
 

.gitignore

@@ -3,6 +3,7 @@ target
 *.log
 log
 activemq-data
+examples/*/Gemfile.lock
 examples/*/tmp
 examples/*/work
 examples/*/*.war

CHANGELOG.md

@@ -4,24 +4,41 @@
 
 ## 1.3.0 (UNRELEASED) 
 
-- Support Javax Servlet API 4.0 (JEE 8)
-- Adds basic compatibility with JRuby 10.0
+- Officially support Javax Servlet API 4.0 (JEE 8)
+- Officially support JRuby 10.0
+
+Breaking compatibility changes
 - Drop support for JRuby 9.3
 - Drop support for Rails < 6.1
-- Drop unnecessary `jruby.compat.version` and `RackConfig.getCompatVersion()` API
+
+Breaking behavioral changes
+- Change context listener to throw by default in case of an exception during initialization
+- Change rails context listener to assume a thread-safe application by default
+
+Breaking Java API changes
 - Drop JMS support
-- Drop deprecated `RackLogger` string (level) constants
-- Drop `jruby.rack.jruby.version` and `jruby.rack.rack.release` keys from rack `env` Hash
+- Drop unnecessary `jruby.compat.version` and `RackConfig.getCompatVersion()` API
+- 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
+- Drop deprecated `RackLogger` string (`level`) constants
+- Custom `RackLogger` implementations must accept `CharSequence` rather than `String` to allow `RubyString` passthrough 
+
+Breaking Ruby API changes
+- Drop deprecated `JRuby::Rack::RailsFileSystemLayout` alias for `JRuby::Rack::FileSystemLayout`
+- Drop deprecated `JRuby::Rack::Errors` alias for `JRuby::Rack::ErrorApp`
 - 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 setting of global `$servlet_context` variable during embedded usage (replaced by `JRuby::Rack.context`)
+
+Breaking configuration capability changes 
+- Drop `jruby.rack.jruby.version` and `jruby.rack.rack.release` keys from rack `env` Hash
+- Drop deprecated and undocumented 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
+
+## 1.2.7 (UNRELEASED)
+
+- Fix ability to include and forward to JSPs under Rails (#370)
+- Update (bundled) rack to 2.2.21 (#374)
 
 ## 1.2.6
 

Gemfile

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

Gemfile.lock

@@ -6,18 +6,18 @@ GEM
       rake
       thor (>= 0.14.0)
     diff-lcs (1.6.2)
-    rack (2.2.20)
-    rake (13.3.0)
-    rspec (3.13.1)
+    rack (2.2.21)
+    rake (13.3.1)
+    rspec (3.13.2)
       rspec-core (~> 3.13.0)
       rspec-expectations (~> 3.13.0)
       rspec-mocks (~> 3.13.0)
-    rspec-core (3.13.5)
+    rspec-core (3.13.6)
       rspec-support (~> 3.13.0)
     rspec-expectations (3.13.5)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-mocks (3.13.6)
+    rspec-mocks (3.13.7)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
     rspec-support (3.13.6)
@@ -33,6 +33,6 @@ PLATFORMS
 
 DEPENDENCIES
   appraisal
-  rack (~> 2.2.20)
+  rack (~> 2.2.21)
   rake (~> 13.3)
   rspec

README.md

@@ -127,7 +127,7 @@ can embed it directly in the `web.xml` as follows (using Sinatra as an example):
 </context-param>
 ```
 
-Be sure to escape angle-brackets for XML !
+Be sure to escape angle-brackets for XML!
 
 
 ## Servlet Filter
@@ -306,6 +306,9 @@ logging system, configure `jruby.rack.logging` as follows:
 For those loggers that require a specific named logger, set it with the
 `jruby.rack.logging.name` option, by default "jruby.rack" name will be used.
 
+## Examples
+
+Some example demo applications are available at [./examples](./examples).
 
 ## Building
 

examples/Kirkfile

@@ -0,0 +1,61 @@
+## JRuby-Rack Examples
+
+This directory includes samples using JRuby-Rack to build Rack web applications for deployment
+into Java app servers.
+
+- All use [Warbler](https://github.com/jruby/warbler) to do so for easy of packaging.
+- Require JRuby `9.4` and a compatible JVM (Java `8` -> `25`).
+
+### Building/running
+
+For deployment into a separate webserver:
+
+1. ```bash
+    bundle
+    bundle exec warble war
+    ```
+2. Drop the war into a relevant Java app server running a compatible JVM version
+
+As an executable jar within Jetty:
+
+1. ```bash
+    bundle
+    bundle exec warble executable war
+    ```
+2. ```shell
+    java -jar *.war
+    ```
+
+## Demo routes
+
+| Example | Component              | Embedded Route                      | Deployed War Route                          |
+|---------|------------------------|-------------------------------------|---------------------------------------------|
+| Rails 7 | Status Page            | http://localhost:8080/up            | http://localhost:8080/rails7/up             |
+| Rails 7 | Snoop Dump             | http://localhost:8080/snoop         | http://localhost:8080/rails7/snoop          |
+| Rails 7 | Simple Form submission | http://localhost:8080/simple_form   | http://localhost:8080/rails7/simple_form    |
+| Rails 7 | Body Posts             | http://localhost:8080/body          | http://localhost:8080/rails7/body           |
+| Rails 7 | JSP (render)           | http://localhost:8080/jsp/          | http://localhost:8080/rails7/jsp/           |
+| Rails 7 | JSP (forward to)       | http://localhost:8080/jsp-forward/  | http://localhost:8080/rails7/jsp-forward/   |
+| Rails 7 | JSP (include)          | http://localhost:8080/jsp-include/  | http://localhost:8080/rails7/jsp-include/   |
+| Sinatra | Demo Index             | http://localhost:8080/              | http://localhost:8080/sinatra               |
+| Sinatra | Info                   | http://localhost:8080/info          | http://localhost:8080/sinatra/info          |
+| Sinatra | Snoop Dump             | http://localhost:8080/env           | http://localhost:8080/sinatra/env           |
+| Sinatra | JSP (render)           | http://localhost:8080/jsp/index.jsp | http://localhost:8080/sinatra/jsp/index.jsp |
+| Sinatra | JSP (forward to)       | http://localhost:8080/jsp_forward   | http://localhost:8080/sinatra/jsp_forward   |
+| Sinatra | JSP (include)          | http://localhost:8080/jsp_include   | http://localhost:8080/sinatra/jsp_include   |
+| Sinatra | Streaming Demo         | http://localhost:8080/stream        | http://localhost:8080/sinatra/stream        |
+| Camping | Demo Index             | http://localhost:8080/              | http://localhost:8080/camping               |
+| Camping | Snoop Dump             | http://localhost:8080/snoop         | http://localhost:8080/camping/snoop         |
+
+## Development
+
+You can run the examples using local source for warbler or jruby-rack using env vars, e.g
+
+```shell
+export WARBLER_SRC=true JRUBY_RACK_SRC=true && bundle && bundle exec warble executable war && java -Dwarbler.debug=true -jar rails*.war
+```
+
+- Warbler can run directly from source
+- jruby-rack needs to be built, since it does not define a gemspec
+  - There are alternate ways to do this by replacing the jruby-rack jar within the warbled jar/war, however this is more
+    complex and error-prone that using the gem and ensuring compatibility since warbler itself depends on the jruby-rack gem. 

examples/README.md

@@ -2,12 +2,11 @@ source 'https://rubygems.org'
 
 ruby '~> 3.1.0'
 
-gem 'rack', '~> 2.2.20'
-gem 'rackup'
 gem 'camping', '< 3'
-gem 'markaby'
+gem 'rack', '~> 2.2.0'
 
 group :development do
-  gem 'warbler', '~> 2.1'
-  gem 'jruby-jars', '< 10'
-end
+  if !ENV['WARBLER_SRC']; gem 'warbler' else gem 'warbler', path: '../../../warbler' end
+  if !ENV['JRUBY_RACK_SRC']; gem 'jruby-rack' else gem 'jruby-rack', path: '../../target' end
+  gem 'jruby-jars', '~> 9.4.0'
+end