[chore] Drop deprecated jruby.rack.ignore.env property, replaced long ago by jruby.runtime.env and optional jruby.runtime.env.rubyopt

chadlwilson · chadlwilson · commit 111a3935c3c4 · 2025-08-19T13:07:59.000+08:00
diff --git a/History.md b/History.md
@@ -9,6 +9,7 @@
 - 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::RailsFileSystemLayout` alias for `JRuby::Rack::FileSystemLayout`
 - Drop deprecated `JRuby::Rack::Errors` alias for `JRuby::Rack::ErrorApp`
 - Change context listener to throw, in case of an exception during initialization, by default
@@ -177,9 +178,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
diff --git a/README.md b/README.md
@@ -224,10 +224,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
diff --git a/examples/servers/Apache-Tomcat-6-0-14.txt b/examples/servers/Apache-Tomcat-6-0-14.txt
@@ -33,8 +33,7 @@ Settings:
 compat_version = 
 filter_adds_html = true
 filter_verifies_resource = false
-ignore_environment = true
-initial_runtimes = 
+initial_runtimes =
 logger = org.jruby.rack.logging.ServletContextLogger@7a14b43d
 logger_class_name = servlet_context
 logger_name = jruby.rack
diff --git a/examples/servers/Apache-Tomcat-7-0-2.txt b/examples/servers/Apache-Tomcat-7-0-2.txt
@@ -33,8 +33,7 @@ Settings:
 compat_version = 
 filter_adds_html = true
 filter_verifies_resource = false
-ignore_environment = true
-initial_runtimes = 
+initial_runtimes =
 logger = org.jruby.rack.logging.ServletContextLogger@398a3257
 logger_class_name = servlet_context
 logger_name = jruby.rack
diff --git a/examples/servers/GlassFish-v3.txt b/examples/servers/GlassFish-v3.txt
@@ -35,8 +35,7 @@ Settings:
 compat_version = 
 filter_adds_html = true
 filter_verifies_resource = false
-ignore_environment = true
-initial_runtimes = 
+initial_runtimes =
 logger = org.jruby.rack.logging.ServletContextLogger@46ee45a5
 logger_class_name = servlet_context
 logger_name = jruby.rack
diff --git a/examples/servers/JBoss-Web-2-1-3-GA.txt b/examples/servers/JBoss-Web-2-1-3-GA.txt
@@ -35,8 +35,7 @@ Settings:
 compat_version = 
 filter_adds_html = true
 filter_verifies_resource = false
-ignore_environment = true
-initial_runtimes = 
+initial_runtimes =
 logger = org.jruby.rack.logging.ServletContextLogger@1a20433b
 logger_class_name = servlet_context
 logger_name = jruby.rack
diff --git a/examples/servers/JBoss-Web-3-0-0-CR1.txt b/examples/servers/JBoss-Web-3-0-0-CR1.txt
@@ -34,8 +34,7 @@ Settings:
 compat_version = 
 filter_adds_html = true
 filter_verifies_resource = false
-ignore_environment = true
-initial_runtimes = 
+initial_runtimes =
 logger = org.jruby.rack.logging.ServletContextLogger@7ee18d93
 logger_class_name = servlet_context
 logger_name = jruby.rack
diff --git a/examples/servers/Resin-4-0-13.txt b/examples/servers/Resin-4-0-13.txt
@@ -33,8 +33,7 @@ Settings:
 compat_version = 
 filter_adds_html = true
 filter_verifies_resource = false
-ignore_environment = true
-initial_runtimes = 
+initial_runtimes =
 logger = org.jruby.rack.logging.ServletContextLogger@6c538793
 logger_class_name = servlet_context
 logger_name = jruby.rack
diff --git a/examples/servers/Winstone-Servlet-Engine-v0-9-10.txt b/examples/servers/Winstone-Servlet-Engine-v0-9-10.txt
@@ -34,8 +34,7 @@ Settings:
 compat_version = 
 filter_adds_html = true
 filter_verifies_resource = false
-ignore_environment = true
-initial_runtimes = 
+initial_runtimes =
 logger = org.jruby.rack.logging.ServletContextLogger@397af435
 logger_class_name = servlet_context
 logger_name = jruby.rack
diff --git a/examples/servers/jetty-6-1-25.txt b/examples/servers/jetty-6-1-25.txt
@@ -34,8 +34,7 @@ Settings:
 compat_version = 
 filter_adds_html = true
 filter_verifies_resource = false
-ignore_environment = true
-initial_runtimes = 
+initial_runtimes =
 logger = org.jruby.rack.logging.ServletContextLogger@1303368e
 logger_class_name = servlet_context
 logger_name = jruby.rack
diff --git a/examples/servers/jetty-7-1-6-v20100715.txt b/examples/servers/jetty-7-1-6-v20100715.txt
@@ -33,8 +33,7 @@ Settings:
 compat_version = 
 filter_adds_html = true
 filter_verifies_resource = false
-ignore_environment = true
-initial_runtimes = 
+initial_runtimes =
 logger = org.jruby.rack.logging.ServletContextLogger@773fc437
 logger_class_name = servlet_context
 logger_name = jruby.rack
diff --git a/src/main/java/org/jruby/rack/DefaultRackConfig.java b/src/main/java/org/jruby/rack/DefaultRackConfig.java
@@ -222,30 +222,21 @@ public Integer getMaximumMemoryBufferSize() {
     @Override
     public Map<String, String> getRuntimeEnvironment() {
         String env = getProperty("jruby.runtime.env");
-        if ( env == null ) env = getProperty("jruby.runtime.environment");
         final Object envFlag = toStrictBoolean(env, null);
         if ( envFlag != null ) {
             // jruby.runtime.env = true keep as is (return null)
             // jruby.runtime.env = false clear env (return empty)
             return (Boolean) envFlag ? new HashMap<>(System.getenv()) : new HashMap<>();
         }
-        if ( isIgnoreEnvironment() ) return new HashMap<>();
         // TODO maybe support custom value 'servlet' to use init params ?
         return toStringMap(env);
     }
 
-    // NOTE: this is only here to be able to maintain previous behavior
-    // jruby.rack.ignore.env did ENV.clear but after RUBYOPT has been processed
+    // NOTE: this allows reinstating earlier behaviour where ENV was only cleared after RUBYOPT has been processed
     static boolean isIgnoreRUBYOPT(RackConfig config) {
-        // RUBYOPT ignored if jruby.runtime.env.rubyopt = false
-        Boolean rubyopt = config.getBooleanProperty("jruby.runtime.env.rubyopt");
-        if ( rubyopt == null ) return ! config.isIgnoreEnvironment();
-        return !rubyopt;
-    }
-
-    @Override
-    public boolean isIgnoreEnvironment() {
-        return getBooleanProperty("jruby.rack.ignore.env", false);
+        // RUBYOPT ignored if jruby.runtime.env.rubyopt = false or unset
+        Boolean retainRubyopt = config.getBooleanProperty("jruby.runtime.env.rubyopt");
+        return retainRubyopt == null || !retainRubyopt;
     }
 
     public boolean isThrowInitException() {
diff --git a/src/main/java/org/jruby/rack/RackConfig.java b/src/main/java/org/jruby/rack/RackConfig.java
@@ -76,24 +76,15 @@ public interface RackConfig {
      * @return the <code>ENV</code> to be used in started Ruby runtimes
      */
     Map<String, String> getRuntimeEnvironment();
-    
-    /** 
-     * Returns true if the outer environment (variables) should not be used.
-     *
-     * @return whether to <code>ENV.clear</code> the Ruby runtime
-     * @deprecated replaced with {@link #getRuntimeEnvironment()}
-     */
-    @Deprecated
-    boolean isIgnoreEnvironment();
-    
+
     /**
      * Return the configured amount of time before runtime acquisition times out (in seconds).
      *
      * @return the amount of time before runtimes acquisition times out
      */
     @Deprecated // TODO rename to Float getRuntimeAquireTimeout
     Integer getRuntimeTimeoutSeconds();
-    
+
     /**
      * Get the number of initializer threads, or null if unspecified.
      *
diff --git a/src/main/java/org/jruby/rack/embed/Config.java b/src/main/java/org/jruby/rack/embed/Config.java
@@ -190,11 +190,6 @@ public boolean isSerialInitialization() {
         throw new UnsupportedOperationException("isSerialInitialization()");
     }
 
-    @Override
-    public boolean isIgnoreEnvironment() {
-        throw new UnsupportedOperationException("isIgnoreEnvironment()");
-    }
-
     @Override
     public Map<String, String> getRuntimeEnvironment() {
         throw new UnsupportedOperationException("getRuntimeEnvironment()");
diff --git a/src/spec/ruby/rack/application_spec.rb b/src/spec/ruby/rack/application_spec.rb
@@ -370,17 +370,6 @@ def newRuntime()
         should_eval_as_eql_to "ENV['RUBYOPT']", '-U'
       end
 
-      it "keeps RUBYOPT by default with empty ENV (backwards compat)" do
-        set_config 'jruby.rack.ignore.env', 'true'
-
-        app_factory = app_factory_with_RUBYOPT '-ryaml'
-        @runtime = app_factory.newRuntime
-        should_eval_as_nil "ENV['HOME']"
-        should_eval_as_eql_to "ENV['RUBYOPT']", '-ryaml' # changed with jruby.runtime.env
-        # it was processed - feature got required :
-        should_eval_as_eql_to "require 'yaml'", false
-      end
-
       it "does a complete ENV clean including RUBYOPT" do
         set_config 'jruby.runtime.env', 'false'
         # set_config 'jruby.runtime.env.rubyopt', 'false'
diff --git a/src/spec/ruby/rack/config_spec.rb b/src/spec/ruby/rack/config_spec.rb
@@ -145,25 +145,19 @@
 
     it "defaults to nil (runtime should keep default from System env)" do
       expect(@servlet_context).to receive(:getInitParameter).
-        with("jruby.runtime.environment").and_return nil
+        with("jruby.runtime.env").and_return nil
       expect(config.getRuntimeEnvironment).to be nil
     end
 
     it "is empty when set to false" do
       expect(@servlet_context).to receive(:getInitParameter).
-        with("jruby.runtime.environment").and_return 'false'
-      expect_empty_env config.getRuntimeEnvironment
-    end
-
-    it "setting jruby.rack.ignore.env returns empty env (backwards compat)" do
-      expect(@servlet_context).to receive(:getInitParameter).
-        with("jruby.rack.ignore.env").and_return 'true'
+        with("jruby.runtime.env").and_return 'false'
       expect_empty_env config.getRuntimeEnvironment
     end
 
     it "custom env hash" do
       expect(@servlet_context).to receive(:getInitParameter).
-        with("jruby.runtime.environment").
+        with("jruby.runtime.env").
         and_return "PATH=~/bin,HOME=/home/kares\nNAMES=Jozko, Ferko,Janko,GEM_HOME=/opt/rvm/gems\n"
       expect(config.getRuntimeEnvironment).to eql({
                                                     "PATH" => "~/bin", "HOME" => "/home/kares", "NAMES" => "Jozko, Ferko,Janko", "GEM_HOME" => "/opt/rvm/gems"
