Ensure compatibility with Rack 2.x and 3.x

.github/workflows/ci.yml

@@ -12,8 +12,12 @@ env:
 jobs:
   build:
     runs-on: ubuntu-latest
-    name: Ruby ${{ matrix.ruby }}
+    name: Ruby ${{ matrix.ruby }} (Rack ~> ${{ matrix.rack }})
     services:
+      redis:
+        image: "redis"
+        ports:
+          - 6379:6379
       memcached:
         image: memcached:1.6.9
         ports:
@@ -22,19 +26,17 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: ["3.4", "3.3", "3.2", "3.1"]
-        redis: ["5.x"]
+        ruby: ["3.4", "3.3", "3.2"]
+        rack: ["2.0", "3.0"]
+    env:
+      RACK_VERSION: ${{ matrix.rack }}
     steps:
       - uses: actions/checkout@v4
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
           bundler-cache: true
           rubygems: latest # `gem update --system` is run to update to the latest compatible RubyGems version.
-      - name: Setup redis
-        uses: shogo82148/actions-setup-redis@v1
-        with:
-          redis-version: ${{ matrix.redis }}
       - name: Tests
         run: bundle exec rspec
       - name: Rubocop

Gemfile

@@ -5,6 +5,10 @@ ruby '>= 2.7.0'
 
 gemspec
 
+if ENV["CI"]
+  gem "rack", "~> #{ENV['RACK_VERSION']}"
+end
+
 group :test do
   gem 'codecov', require: false
   gem 'stackprof', require: false

lib/mini_profiler.rb

@@ -329,7 +329,7 @@ def call(env)
             )
           end
         elsif path == '/rack-mini-profiler/requests'
-          status, headers, body = [200, { 'Content-Type' => 'text/html' }, [blank_page_html.dup]] # important to dup here!
+          status, headers, body = [200, { Rack::CONTENT_TYPE => 'text/html' }, [blank_page_html.dup]] # important to dup here!
         else
           status, headers, body = @app.call(env)
         end
@@ -423,20 +423,20 @@ def action_parameters(env)
     def inject_profiler(env, status, headers, body)
       # mini profiler is meddling with stuff, we can not cache cause we will get incorrect data
       # Rack::ETag has already inserted some nonesense in the chain
-      content_type = headers['Content-Type']
+      content_type = headers[Rack::CONTENT_TYPE]
 
       if config.disable_caching
-        headers.delete('ETag')
-        headers.delete('Date')
+        headers.delete(Rack::ETAG)
+        headers.delete('date') || headers.delete('Date')
       end
 
-      headers['X-MiniProfiler-Original-Cache-Control'] = headers['Cache-Control'] unless headers['Cache-Control'].nil?
-      headers['Cache-Control'] = "#{"no-store, " if config.disable_caching}must-revalidate, private, max-age=0"
+      headers['x-miniprofiler-original-cache-control'] = headers[Rack::CACHE_CONTROL] unless headers[Rack::CACHE_CONTROL].nil?
+      headers[Rack::CACHE_CONTROL] = "#{"no-store, " if config.disable_caching}must-revalidate, private, max-age=0"
 
       # inject header
       if headers.is_a? Hash
-        headers['X-MiniProfiler-Ids'] = ids_comma_separated(env)
-        headers['X-MiniProfiler-Flamegraph-Path'] = flamegraph_path(env) if current.page_struct[:has_flamegraph]
+        headers['x-miniprofiler-ids'] = ids_comma_separated(env)
+        headers['x-miniprofiler-flamegraph-path'] = flamegraph_path(env) if current.page_struct[:has_flamegraph]
       end
 
       if current.inject_js && content_type =~ /text\/html/
@@ -589,7 +589,7 @@ def analyze_memory
     end
 
     def text_result(body, status: 200, headers: nil)
-      headers = (headers || {}).merge('Content-Type' => 'text/plain; charset=utf-8')
+      headers = (headers || {}).merge(Rack::CONTENT_TYPE => 'text/plain; charset=utf-8')
       [status, headers, [body]]
     end
 

lib/mini_profiler/gc_profiler.rb

@@ -151,7 +151,7 @@ def profile_gc(app, env)
       body << "#{count} : #{string}\n"
     end
 
-    [200, { 'Content-Type' => 'text/plain' }, body]
+    [200, { Rack::CONTENT_TYPE => 'text/plain' }, body]
   ensure
     prev_gc_state ? GC.disable : GC.enable
   end

spec/integration/middleware_spec.rb

@@ -20,7 +20,7 @@ def decompressed_response
     def app
       Rack::Builder.new do
         use Rack::MiniProfiler
-        run lambda { |_env| [200, { 'Content-Type' => 'text/html' }, [+'<html><body><h1>Hi</h1></body></html>']] }
+        run lambda { |_env| [200, { Rack::CONTENT_TYPE => 'text/html' }, [+'<html><body><h1>Hi</h1></body></html>']] }
       end
     end
     it 'is an empty page' do
@@ -35,7 +35,7 @@ def app
     def app
       Rack::Builder.new do
         use Rack::MiniProfiler
-        run lambda { |_env| [200, { 'Content-Type' => 'text/html' }, [+'<html><body><h1>Hi</h1></body></html>']] }
+        run lambda { |_env| [200, { Rack::CONTENT_TYPE => 'text/html' }, [+'<html><body><h1>Hi</h1></body></html>']] }
       end
     end
     it 'shows commands' do
@@ -75,7 +75,7 @@ def app
     def app
       Rack::Builder.new do
         use Rack::MiniProfiler
-        run lambda { |_env| [200, { 'Content-Type' => 'text/html' }, [+'<html><body><h1>Hi</h1></body></html>']] }
+        run lambda { |_env| [200, { Rack::CONTENT_TYPE => 'text/html' }, [+'<html><body><h1>Hi</h1></body></html>']] }
       end
     end
     it 'advanced tools are disabled' do
@@ -94,7 +94,7 @@ def app
           lambda do |_env|
             [
               201,
-              { 'Content-Type' => 'text/html', 'X-CUSTOM' => "1" },
+              { Rack::CONTENT_TYPE => 'text/html', 'X-CUSTOM' => "1" },
               [+'<html><body><h1>Hi</h1></body></html>'],
             ]
           end
@@ -118,7 +118,7 @@ def app
         expect(last_response.body).to eq(
           'Please install the memory_profiler gem and require it: add gem \'memory_profiler\' to your Gemfile'
         )
-        expect(last_response.headers['Content-Type']).to eq('text/plain; charset=utf-8')
+        expect(last_response.headers[Rack::CONTENT_TYPE]).to eq('text/plain; charset=utf-8')
         expect(last_response.headers['X-CUSTOM']).to eq('1')
         expect(last_response.status).to eq(500)
       end
@@ -130,7 +130,7 @@ def app
         expect(last_response.body).to eq(
           'Please install the stackprof gem and require it: add gem \'stackprof\' to your Gemfile'
         )
-        expect(last_response.headers['Content-Type']).to eq('text/plain; charset=utf-8')
+        expect(last_response.headers[Rack::CONTENT_TYPE]).to eq('text/plain; charset=utf-8')
         expect(last_response.headers['X-CUSTOM']).to eq('1')
         expect(last_response.status).to eq(201)
       end
@@ -142,7 +142,7 @@ def app
         expect(last_response.body).to eq(
           'Please install the stackprof gem and require it: add gem \'stackprof\' to your Gemfile'
         )
-        expect(last_response.headers['Content-Type']).to eq('text/plain; charset=utf-8')
+        expect(last_response.headers[Rack::CONTENT_TYPE]).to eq('text/plain; charset=utf-8')
         expect(last_response.headers['X-CUSTOM']).to eq('1')
         expect(last_response.status).to eq(201)
       end
@@ -154,7 +154,7 @@ def app
       Rack::Builder.new do
         use Rack::MiniProfiler
         use Rack::Deflater
-        run lambda { |_env| [200, { 'Content-Type' => 'text/html' }, [+'<html><body><h1>Hi</h1></body></html>']] }
+        run lambda { |_env| [200, { Rack::CONTENT_TYPE => 'text/html' }, [+'<html><body><h1>Hi</h1></body></html>']] }
       end
     end
 
@@ -190,7 +190,7 @@ def app
       Rack::Builder.new do
         use Rack::Deflater
         use Rack::MiniProfiler
-        run lambda { |_env| [200, { 'Content-Type' => 'text/html' }, [+'<html><body><h1>Hi</h1></body></html>']] }
+        run lambda { |_env| [200, { Rack::CONTENT_TYPE => 'text/html' }, [+'<html><body><h1>Hi</h1></body></html>']] }
       end
     end
 
@@ -223,7 +223,7 @@ def app
     def app
       Rack::Builder.new do
         use Rack::MiniProfiler
-        run lambda { |_env| [200, { 'Content-Type' => 'text/html' }, [+'<html><body><h1>Hi</h1></body></html>']] }
+        run lambda { |_env| [200, { Rack::CONTENT_TYPE => 'text/html' }, [+'<html><body><h1>Hi</h1></body></html>']] }
       end
     end
 
@@ -249,7 +249,7 @@ def app
         use Rack::MiniProfiler
         run lambda { |env|
           env["action_dispatch.content_security_policy_nonce"] = "railsnonce"
-          [200, { 'Content-Type' => 'text/html' }, [+'<html><body><h1>Hello world</h1></body></html>']]
+          [200, { Rack::CONTENT_TYPE => 'text/html' }, [+'<html><body><h1>Hello world</h1></body></html>']]
         }
       end
     end
@@ -278,7 +278,7 @@ def app
 
       (env, response_headers) = proc_arguments
       expect(env["REQUEST_METHOD"]).to eq("GET")
-      expect(response_headers["Content-Type"]).to eq("text/html")
+      expect(response_headers[Rack::CONTENT_TYPE]).to eq("text/html")
     end
   end
 end

spec/integration/mini_profiler_spec.rb

@@ -10,88 +10,88 @@ def app
     @app ||= Rack::Builder.new {
       use Rack::MiniProfiler
       map '/path2/a' do
-        run lambda { |env| [200, { 'Content-Type' => 'text/html' }, +'<h1>path1</h1>'] }
+        run lambda { |env| [200, { Rack::CONTENT_TYPE => 'text/html' }, +'<h1>path1</h1>'] }
       end
       map '/path1/a' do
-        run lambda { |env| [200, { 'Content-Type' => 'text/html' }, +'<h1>path2</h1>'] }
+        run lambda { |env| [200, { Rack::CONTENT_TYPE => 'text/html' }, +'<h1>path2</h1>'] }
       end
       map '/cached-resource' do
         run lambda { |env|
           ims = env['HTTP_IF_MODIFIED_SINCE'] || ""
           if ims.size > 0
-            [304, { 'Content-Type' => 'application/json' }, '']
+            [304, { Rack::CONTENT_TYPE => 'application/json' }, '']
           else
-            [200, { 'Content-Type' => 'application/json', 'Cache-Control' => 'original-cache-control' }, '{"name": "Ryan"}']
+            [200, { Rack::CONTENT_TYPE => 'application/json', Rack::CACHE_CONTROL => 'original-cache-control' }, '{"name": "Ryan"}']
           end
         }
       end
       map '/post' do
-        run lambda { |env| [302, { 'Content-Type' => 'text/html' }, +'<h1>POST</h1>'] }
+        run lambda { |env| [302, { Rack::CONTENT_TYPE => 'text/html' }, +'<h1>POST</h1>'] }
       end
       map '/html' do
-        run lambda { |env| [200, { 'Content-Type' => 'text/html' }, +"<html><BODY><h1>Hi</h1></BODY>\n \t</html>"] }
+        run lambda { |env| [200, { Rack::CONTENT_TYPE => 'text/html' }, +"<html><BODY><h1>Hi</h1></BODY>\n \t</html>"] }
       end
       map '/explicitly-allowed-html' do
         run lambda { |env|
           Rack::MiniProfiler.authorize_request
-          [200, { 'Content-Type' => 'text/html' }, +"<html><BODY><h1>Hi</h1></BODY>\n \t</html>"]
+          [200, { Rack::CONTENT_TYPE => 'text/html' }, +"<html><BODY><h1>Hi</h1></BODY>\n \t</html>"]
         }
       end
       map '/implicitbody' do
-        run lambda { |env| [200, { 'Content-Type' => 'text/html' }, +"<html><h1>Hi</h1></html>"] }
+        run lambda { |env| [200, { Rack::CONTENT_TYPE => 'text/html' }, +"<html><h1>Hi</h1></html>"] }
       end
       map '/implicitbodyhtml' do
-        run lambda { |env| [200, { 'Content-Type' => 'text/html' }, +"<h1>Hi</h1>"] }
+        run lambda { |env| [200, { Rack::CONTENT_TYPE => 'text/html' }, +"<h1>Hi</h1>"] }
       end
       map '/db' do
         run lambda { |env|
           ::Rack::MiniProfiler.record_sql("I want to be, in a db", 10)
-          [200, { 'Content-Type' => 'text/html' }, +'<h1>Hi+db</h1>']
+          [200, { Rack::CONTENT_TYPE => 'text/html' }, +'<h1>Hi+db</h1>']
         }
       end
       map '/3ms' do
         run lambda { |env|
           sleep(0.003)
-          [200, { 'Content-Type' => 'text/html' }, +'<h1>Hi</h1>']
+          [200, { Rack::CONTENT_TYPE => 'text/html' }, +'<h1>Hi</h1>']
         }
       end
       map '/explicitly-allowed' do
         run lambda { |env|
           Rack::MiniProfiler.authorize_request
-          [200, { 'Content-Type' => 'text/html' }, +'<h1>path1</h1>']
+          [200, { Rack::CONTENT_TYPE => 'text/html' }, +'<h1>path1</h1>']
         }
       end
       map '/rails_engine' do
         run lambda { |env|
           env['SCRIPT_NAME'] = '/rails_engine'  # Rails engines do that
-          [200, { 'Content-Type' => 'text/html' }, +'<html><h1>Hi</h1></html>']
+          [200, { Rack::CONTENT_TYPE => 'text/html' }, +'<html><h1>Hi</h1></html>']
         }
       end
       map '/under_passenger' do
         run lambda { |env|
-          [200, { 'Content-Type' => 'text/html' }, +'<html><h1>and I ride and I ride</h1></html>']
+          [200, { Rack::CONTENT_TYPE => 'text/html' }, +'<html><h1>and I ride and I ride</h1></html>']
         }
       end
       map '/create' do
         run lambda { |env|
-          [201, { 'Content-Type' => 'text/html' }, +'<html><h1>success</h1></html>']
+          [201, { Rack::CONTENT_TYPE => 'text/html' }, +'<html><h1>success</h1></html>']
         }
       end
       map '/notallowed' do
         run lambda { |env|
-          [403, { 'Content-Type' => 'text/html' }, +'<html><h1>you are not allowed here</h1></html>']
+          [403, { Rack::CONTENT_TYPE => 'text/html' }, +'<html><h1>you are not allowed here</h1></html>']
         }
       end
       map '/whoopsie-daisy' do
         run lambda { |env|
-          [500, { 'Content-Type' => 'text/html' }, +'<html><h1>whoopsie daisy</h1></html>']
+          [500, { Rack::CONTENT_TYPE => 'text/html' }, +'<html><h1>whoopsie daisy</h1></html>']
         }
       end
       map '/test-snapshots-custom-fields' do
         run lambda { |env|
           qp = Rack::Utils.parse_nested_query(env['QUERY_STRING'])
           qp.each { |k, v| Rack::MiniProfiler.add_snapshot_custom_field(k, v) }
-          [200, { 'Content-Type' => 'text/html' }, +'<html><h1>custom fields</h1></html>']
+          [200, { Rack::CONTENT_TYPE => 'text/html' }, +'<html><h1>custom fields</h1></html>']
         }
       end
     }.to_app
@@ -450,12 +450,12 @@ def load_prof(response)
   describe 'gc profiler' do
     it "should return a report" do
       get '/html?pp=profile-gc'
-      expect(last_response['Content-Type']).to include('text/plain')
+      expect(last_response[Rack::CONTENT_TYPE]).to include('text/plain')
     end
 
     it "should return a report when an HTTP header is used" do
       get '/html', nil, { 'HTTP_X_RACK_MINI_PROFILER' => 'profile-gc' }
-      expect(last_response['Content-Type']).to include('text/plain')
+      expect(last_response[Rack::CONTENT_TYPE]).to include('text/plain')
     end
   end
 

spec/integration/trace_exceptions_spec.rb

@@ -14,7 +14,7 @@ def app
     @app ||= Rack::Builder.new {
       use Rack::MiniProfiler
       map '/no_exceptions' do
-        run lambda { |_env| [200, { 'Content-Type' => 'text/html' }, '<h1>Success</h1>'] }
+        run lambda { |_env| [200, { Rack::CONTENT_TYPE => 'text/html' }, '<h1>Success</h1>'] }
       end
       map '/raise_exceptions' do
         # This route raises 3 exceptions, catches them, and returns a successful response
@@ -34,7 +34,7 @@ def app
           rescue
             # Ignore the exception
           end
-          [200, { 'Content-Type' => 'text/html' }, '<h1>Exception raised but success returned</h1>']
+          [200, { Rack::CONTENT_TYPE => 'text/html' }, '<h1>Exception raised but success returned</h1>']
         }
       end
     }.to_app

spec/lib/client_settings_spec.rb

@@ -44,23 +44,23 @@
       @settings.disable_profiling = false
       hash = {}
       @settings.write!(hash)
-      expect(hash["set-cookie"]).to include("path=/;")
+      expect(hash[Rack::SET_COOKIE]).to include("path=/;")
     end
 
     it 'should correctly set cookie with correct path' do
       Rack::MiniProfiler.config.cookie_path = '/test'
       @settings.disable_profiling = false
       hash = {}
       @settings.write!(hash)
-      expect(hash["set-cookie"]).to include("path=/test;")
+      expect(hash[Rack::SET_COOKIE]).to include("path=/test;")
     end
 
     it 'writes auth token for authorized reqs' do
       Rack::MiniProfiler.config.authorization_mode = :allow_authorized
       Rack::MiniProfiler.authorize_request
       hash = {}
       @settings.write!(hash)
-      expect(hash["set-cookie"]).to include(@store.allowed_tokens.join("|"))
+      expect(hash[Rack::SET_COOKIE]).to include(@store.allowed_tokens.join("|"))
     end
 
     it 'does nothing on short unauthed requests' do
@@ -80,7 +80,7 @@
         @settings.handle_cookie([200, hash, []])
       end
 
-      expect(hash["set-cookie"]).to include("max-age=0")
+      expect(hash[Rack::SET_COOKIE]).to include("max-age=0")
     end
   end