rack-berater 0.3.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5840eaff6319d5e24c78c2f50960138ca27fcce25bb3d45354e7eca195b50f0d
-  data.tar.gz: f9cdde9f38c97d82e03d6a1e9cea2e1939eaca13f4202a2a674a6fda4e6f530e
+  metadata.gz: d7cdec5112bd0a056e38bba20ca0c6c25c84f6703f1c031469b815806ef7f25a
+  data.tar.gz: 390634760abee230969aa03f51ad7eb86dc3372f17d4d0c1597cb759db4804fa
 SHA512:
-  metadata.gz: b0f561957104a0d049d161b720615a97474439c41f16507b3bd34a1f68269fccbea314f54736393a5e030abdf755de8ae30bc5a92724502371728975b6cf7460
-  data.tar.gz: f91a4cb03f24b7c18554c8145375a78f1b61cc66a2d99a0841ddca4b547dc97822bd99dfe9267ae1feeb01d3e2c8eba72d70ea075d367671f3e2077e404a8e36
+  metadata.gz: cae54a952dec822b533f3f16d555cc5215e888f0783c3fc5d9d266cc8f7b7f14884068e603e19e4e2c1880adcff1bd2adbf73de025cc93095da14b105f89cc8e
+  data.tar.gz: 44b0008bc762dfd16b28a9a731ee8c5be5a766e48341828b7c49df9967fbb48cc213955c199b61cbd5abae2bae7e5b4b207ce46e8e6afdd22564d916be49f73a

data/lib/rack/berater/prioritizer.rb

@@ -9,6 +9,8 @@ module Rack
       def initialize(app, options = {})
         @app = app
         @header = options[:header] || HEADER
+
+        synchronize { @@cache ||= {} }
       end
 
       def call(env)
@@ -48,31 +50,15 @@ module Rack
         Thread.current[ENV_KEY] = priority
       end
 
-      @@cache_prefix = 'Berater:Rack:Prioritizer'
       def cache_key_for(env)
-        req = Rack::Request.new(env)
-
-        req_method = env[Rack::REQUEST_METHOD].downcase
-        path = ''
-
-        if defined?(Rails) && Rails.application
-          res = Rails.application.routes.recognize_path(env[Rack::PATH_INFO])
-          path = res.values_at(:controller, :action).compact.join('#')
-        end
-
-        if path.empty?
-          path = env['PATH_INFO'].gsub(%r{/[0-9]+(/|$)}, '/x\1')
-        end
-
         [
-          @@cache_prefix,
-          req_method,
-          path,
+          env[Rack::REQUEST_METHOD].downcase,
+
+          # normalize RESTful paths
+          env['PATH_INFO'].gsub(%r{/[0-9]+(/|$)}, '/x\1'),
         ].join(':')
       end
 
-      @@cache = {}
-
       def cache_get(key)
         synchronize { @@cache[key] }
       end

data/lib/rack/berater/rails_prioritizer.rb

@@ -0,0 +1,17 @@
+require 'action_controller/metal'
+require 'action_dispatch'
+
+module Rack
+  class Berater
+    class RailsPrioritizer < Prioritizer
+      def cache_key_for(env)
+        Rails.application.routes.recognize_path(
+          env[Rack::PATH_INFO],
+          method: env[Rack::REQUEST_METHOD],
+        ).values_at(:controller, :action).compact.join('#')
+      rescue ActionController::RoutingError
+        super
+      end
+    end
+  end
+end

data/lib/rack/berater/railtie.rb

@@ -5,7 +5,7 @@ module Rack
     class Railtie < Rails::Railtie
       initializer 'rack.berater' do |app|
         if ::Berater.middleware.include?(::Berater::Middleware::LoadShedder)
-          app.middleware.use Rack::Berater::Prioritizer
+          app.middleware.use Rack::Berater::RailsPrioritizer
         end
 
         app.middleware.use Rack::Berater

data/lib/rack/berater/rspec.rb

@@ -0,0 +1,9 @@
+require 'rack/berater'
+require 'rspec/core'
+
+RSpec.configure do |config|
+  config.after do
+    Thread.current[Rack::Berater::Prioritizer::ENV_KEY] = nil
+    Rack::Berater::Prioritizer.class_variable_get(:@@cache).clear
+  end
+end

data/lib/rack/berater/version.rb

@@ -1,5 +1,5 @@
 module Rack
   class Berater
-    VERSION = "0.3.0"
+    VERSION = "0.4.1"
   end
 end

data/lib/rack/berater.rb

@@ -6,6 +6,7 @@ require 'set'
 module Rack
   class Berater
     autoload :Prioritizer, 'rack/berater/prioritizer'
+    autoload :RailsPrioritizer, 'rack/berater/rails_prioritizer'
     autoload :Railtie, 'rack/berater/railtie'
 
     ERRORS = Set[ ::Berater::Overloaded ]

data/spec/prioritizer_spec.rb

@@ -1,9 +1,4 @@
 describe Rack::Berater::Prioritizer do
-  after do
-    cache.clear
-    Thread.current[described_class::ENV_KEY] = nil
-  end
-
   let(:cache) { described_class.class_variable_get(:@@cache) }
 
   describe '#call' do
@@ -117,12 +112,8 @@ describe Rack::Berater::Prioritizer do
     context 'with a basic env' do
       let(:env) { Rack::MockRequest.env_for('/') }
 
-      it 'has a Berater prefix' do
-        is_expected.to match /^Berater:/
-      end
-
       it 'combines the verb and path' do
-        is_expected.to match %r{:get:/$}
+        is_expected.to match %r{get:/$}
       end
     end
 
@@ -130,7 +121,7 @@ describe Rack::Berater::Prioritizer do
       let(:env) { Rack::MockRequest.env_for('/', method: 'PUT') }
 
       it 'combines the verb and path' do
-        is_expected.to match %r{:put:/$}
+        is_expected.to match %r{put:/$}
       end
     end
 
@@ -138,7 +129,7 @@ describe Rack::Berater::Prioritizer do
       let(:env) { Rack::MockRequest.env_for('/user/123') }
 
       it 'normalizes the id' do
-        is_expected.to match %r{:/user/x$}
+        is_expected.to match %r{get:/user/x$}
       end
     end
 
@@ -146,7 +137,7 @@ describe Rack::Berater::Prioritizer do
       let(:env) { Rack::MockRequest.env_for('/user/123/') }
 
       it 'normalizes the id and keeps the trailing slash' do
-        is_expected.to match %r{:/user/x/$}
+        is_expected.to match %r{get:/user/x/$}
       end
     end
 
@@ -154,7 +145,7 @@ describe Rack::Berater::Prioritizer do
       let(:env) { Rack::MockRequest.env_for('/user/123/friend/456') }
 
       it 'normalizes both ids' do
-        is_expected.to match %r{:/user/x/friend/x$}
+        is_expected.to match %r{get:/user/x/friend/x$}
       end
     end
   end
@@ -219,77 +210,4 @@ describe Rack::Berater::Prioritizer do
     #   end
     # end
   end
-
-  context 'as Rails middleware' do
-    before do
-      class EchoController < ActionController::Base
-        def index
-          render plain: Rack::Berater::Prioritizer.current_priority
-        end
-
-        def six
-          response.set_header(Rack::Berater::Prioritizer::HEADER, '6')
-          index
-        end
-
-        def nine
-          response.set_header(Rack::Berater::Prioritizer::HEADER, '9')
-          index
-        end
-      end
-
-      Rails.application = Class.new(Rails::Application) do
-        config.eager_load = false
-        config.hosts.clear # disable hostname filtering
-      end
-      Rails.application.middleware.use described_class
-      Rails.initialize!
-
-      Rails.application.routes.draw do
-        get '/' => 'echo#index'
-        get '/six' => 'echo#six'
-        get '/nine' => 'echo#nine'
-      end
-    end
-
-    let(:app) { Rails.application }
-    let(:middleware) { described_class.new(app) }
-
-    after { Rails.application = nil }
-
-    describe '#cache_key_for' do
-      subject { described_class.new(app).send(:cache_key_for, env) }
-
-      let(:env) { Rack::MockRequest.env_for('/') }
-
-      it 'uses the controller and action name' do
-        is_expected.to match %r{:echo#index$}
-      end
-    end
-
-    context 'when a priority header is sent' do
-      before { header described_class::HEADER, priority }
-
-      let(:priority) { '6' }
-
-      it 'sets the priority' do
-        expect(get('/six').body).to eq priority
-      end
-    end
-
-    context 'when the app returns a priority' do
-      it 'does not know the first time the controller is called' do
-        expect(get('/six').body).to be_empty
-        expect(get('/nine').body).to be_empty
-      end
-
-      it 'caches the repsonses for the second time' do
-        expect(get('/six').body).to be_empty
-        expect(get('/nine').body).to be_empty
-
-        expect(get('/six').body).to eq '6'
-        expect(get('/nine').body).to eq '9'
-      end
-    end
-  end
 end

data/spec/rails_prioritizer_spec.rb

@@ -0,0 +1,100 @@
+require 'rspec/rails'
+
+describe Rack::Berater::RailsPrioritizer do
+  before do
+    class EchoController < ActionController::Base
+      def index
+        render plain: Rack::Berater::Prioritizer.current_priority
+      end
+
+      def six
+        response.set_header(Rack::Berater::Prioritizer::HEADER, '6')
+        index
+      end
+
+      def nine
+        response.set_header(Rack::Berater::Prioritizer::HEADER, '9')
+        index
+      end
+    end
+
+    Rails.application = Class.new(Rails::Application) do
+      config.eager_load = false
+      config.hosts.clear # disable hostname filtering
+      # config.logger = ActiveSupport::Logger.new($stdout)
+    end
+    Rails.application.middleware.use described_class
+    Rails.initialize!
+
+    Rails.application.routes.draw do
+      get '/' => 'echo#index'
+      get '/six' => 'echo#six'
+      post '/nine' => 'echo#nine'
+      get '/redirect' => redirect('/')
+    end
+  end
+
+  let(:app) { Rails.application }
+  let(:middleware) { described_class.new(app) }
+
+  after do
+    Rails.application = nil
+  end
+
+  let(:cache) { described_class.class_variable_get(:@@cache) }
+
+  describe '#cache_key_for' do
+    subject { described_class.new(app).method(:cache_key_for) }
+
+    it 'uses the controller and action name' do
+      expect(
+        subject.call(Rack::MockRequest.env_for('/'))
+      ).to match /echo#index/
+
+      expect(
+        subject.call(Rack::MockRequest.env_for('/six'))
+      ).to match /echo#six/
+
+      expect(
+        subject.call(Rack::MockRequest.env_for('/nine', method: 'POST'))
+      ).to match /echo#nine/
+    end
+
+    it 'falls back to Rack style names' do
+      expect(
+        subject.call(Rack::MockRequest.env_for('/nine'))
+      ).to match %r{get:/nine}
+    end
+
+    it 'works with redirects' do
+      expect(
+        subject.call(Rack::MockRequest.env_for('/redirect'))
+      ).to match %r{get:/redirect}
+    end
+  end
+
+  context 'when a priority header is sent' do
+    before { header described_class::HEADER, priority }
+
+    let(:priority) { '6' }
+
+    it 'sets the priority' do
+      expect(get('/six').body).to eq priority
+    end
+  end
+
+  context 'when the app returns a priority' do
+    it 'does not know the first time the controller is called' do
+      expect(get('/six').body).to be_empty
+      expect(post('/nine').body).to be_empty
+    end
+
+    it 'caches the repsonses for the second time' do
+      expect(get('/six').body).to be_empty
+      expect(post('/nine').body).to be_empty
+
+      expect(get('/six').body).to eq '6'
+      expect(post('/nine').body).to eq '9'
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rack-berater
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Daniel Pepper
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-11-17 00:00:00.000000000 Z
+date: 2021-11-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: berater
@@ -108,6 +108,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -131,10 +145,13 @@ files:
 - lib/rack-berater.rb
 - lib/rack/berater.rb
 - lib/rack/berater/prioritizer.rb
+- lib/rack/berater/rails_prioritizer.rb
 - lib/rack/berater/railtie.rb
+- lib/rack/berater/rspec.rb
 - lib/rack/berater/version.rb
 - spec/limiter_spec.rb
 - spec/prioritizer_spec.rb
+- spec/rails_prioritizer_spec.rb
 - spec/railtie_spec.rb
 - spec/rescuer_spec.rb
 homepage: https://github.com/dpep/rack-berater
@@ -161,6 +178,7 @@ signing_key:
 specification_version: 4
 summary: Rack::Berater
 test_files:
+- spec/rails_prioritizer_spec.rb
 - spec/railtie_spec.rb
 - spec/rescuer_spec.rb
 - spec/prioritizer_spec.rb