rack-berater 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d7cdec5112bd0a056e38bba20ca0c6c25c84f6703f1c031469b815806ef7f25a
-  data.tar.gz: 390634760abee230969aa03f51ad7eb86dc3372f17d4d0c1597cb759db4804fa
+  metadata.gz: 879e22ae9d610e5c47f9866c76409c71cd335558c79d69e43bce71bea1f0d8b8
+  data.tar.gz: 7a04e12d16de13936a6ec8e0bad8130c1ab465e5625627d5be9cf24e5e694e8b
 SHA512:
-  metadata.gz: cae54a952dec822b533f3f16d555cc5215e888f0783c3fc5d9d266cc8f7b7f14884068e603e19e4e2c1880adcff1bd2adbf73de025cc93095da14b105f89cc8e
-  data.tar.gz: 44b0008bc762dfd16b28a9a731ee8c5be5a766e48341828b7c49df9967fbb48cc213955c199b61cbd5abae2bae7e5b4b207ce46e8e6afdd22564d916be49f73a
+  metadata.gz: 357bc1725eb43ae4ea0a664c648b78aecfd89648606e62b24fac3ff799b19464819f68bdf550ee3f9dc57757377b6c66c5fbea6914a4d45043e830ba427b38fe
+  data.tar.gz: 1472454e024edbb12637a886a4e1c91553ae6ac094278801428cec7dc6f8c52a3dad7218acaf811efd9b903390930e9c55c6476eaf9b795672f98c91e80a55fb

data/lib/rack/berater/graphql_prioritizer.rb

@@ -0,0 +1,31 @@
+module Rack
+  class Berater
+    class GraphqlPrioritizer < Prioritizer
+      def cache_key_for(env)
+        request = Rack::Request.new(env)
+
+        if request.path == '/graphql'
+          parts = [ 'graphql' ]
+
+          if request.params['operationName']
+            parts << request.params['operationName']
+          elsif request.params['query']
+            op = begin
+              GraphQL.parse(request.params['query']).definitions.find do |x|
+                x.is_a? GraphQL::Language::Nodes::OperationDefinition
+              end
+            rescue GraphQL::ParseError
+              nil
+            end
+
+            parts << op.name if op
+          end
+
+          parts.join(':')
+        else
+          super
+        end
+      end
+    end
+  end
+end

data/lib/rack/berater/prioritizer.rb

@@ -9,15 +9,13 @@ module Rack
       def initialize(app, options = {})
         @app = app
         @header = options[:header] || HEADER
-
-        synchronize { @@cache ||= {} }
       end
 
       def call(env)
         priority = env[@header] || env["HTTP_#{@header.upcase.tr('-', '_')}"]
 
         if priority
-          set_priority(priority)
+          self.priority = priority
           return @app.call(env)
         end
 
@@ -25,11 +23,11 @@ module Rack
         cached_priority = cache_get(cache_key)
 
         if cached_priority
-          set_priority(cached_priority)
+          self.priority = cached_priority
         end
 
         @app.call(env).tap do |status, headers, body|
-          app_priority = headers.delete(@header) if headers
+          app_priority = (headers.delete(@header) || headers.delete(@header.downcase)) if headers
 
           if app_priority && app_priority != cached_priority
             # update cache for next time
@@ -46,19 +44,20 @@ module Rack
 
       protected
 
-      def set_priority(priority)
+      def priority=(priority)
         Thread.current[ENV_KEY] = priority
       end
 
       def cache_key_for(env)
         [
-          env[Rack::REQUEST_METHOD].downcase,
+          env[Rack::REQUEST_METHOD],
 
           # 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

@@ -1,6 +1,3 @@
-require 'action_controller/metal'
-require 'action_dispatch'
-
 module Rack
   class Berater
     class RailsPrioritizer < Prioritizer
@@ -9,7 +6,7 @@ module Rack
           env[Rack::PATH_INFO],
           method: env[Rack::REQUEST_METHOD],
         ).values_at(:controller, :action).compact.join('#')
-      rescue ActionController::RoutingError
+      rescue ActionController::RoutingError, NoMethodError
         super
       end
     end

data/lib/rack/berater/rspec.rb

@@ -4,6 +4,7 @@ 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.4.1"
+    VERSION = "0.5.0"
   end
 end

data/lib/rack/berater.rb

@@ -5,6 +5,7 @@ require 'set'
 
 module Rack
   class Berater
+    autoload :GraphqlPrioritizer, 'rack/berater/graphql_prioritizer'
     autoload :Prioritizer, 'rack/berater/prioritizer'
     autoload :RailsPrioritizer, 'rack/berater/rails_prioritizer'
     autoload :Railtie, 'rack/berater/railtie'

data/spec/graphql_prioritizer_spec.rb

@@ -0,0 +1,104 @@
+require 'graphql'
+
+class UserType < GraphQL::Schema::Object
+  field :name, String, null: false
+end
+
+class QueryType < GraphQL::Schema::Object
+  field :me, UserType
+
+  def me
+    { name: 'me' }
+  end
+
+  field :user, UserType do
+    argument :id, ID
+  end
+
+  def user(id:)
+    { name: "user_#{id}" }
+  end
+end
+
+class Schema < GraphQL::Schema
+  query QueryType
+end
+
+class GraphqlController < ActionController::Base
+  def execute
+    render json: Schema.execute(
+      params[:query],
+      variables: params[:variables],
+      operation_name: params[:operationName]
+    )
+  end
+end
+
+describe Rack::Berater::GraphqlPrioritizer do
+  before do
+    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
+      post '/graphql', to: 'graphql#execute'
+    end
+  end
+
+  let(:app) { Rails.application }
+  let(:query) { 'query Me { me { name } }'}
+
+  describe '#cache_key_for' do
+    subject { described_class.new(app).method(:cache_key_for) }
+
+    it 'uses the implicit graphql operation name' do
+      expect(
+        subject.call(Rack::MockRequest.env_for(
+          '/graphql',
+          params: {
+            query: query,
+          },
+        ))
+      ).to match /graphql:Me/
+    end
+
+    it 'uses the explicit graphql operation name param' do
+      expect(
+        subject.call(Rack::MockRequest.env_for(
+          '/graphql',
+          params: {
+            query: query,
+            operationName: 'What',
+          },
+        ))
+      ).to match /graphql:What/
+    end
+
+    it 'works when operation name is missing' do
+      expect(
+        subject.call(Rack::MockRequest.env_for('/graphql'))
+      ).to match /graphql/
+    end
+
+    it 'works when query is invalid' do
+      expect(
+        subject.call(Rack::MockRequest.env_for(
+          '/graphql',
+          params: {
+            query: 'abc!!!',
+          },
+        ))
+      ).to match /graphql/
+    end
+
+    it 'falls back to Rack style names' do
+      expect(
+        subject.call(Rack::MockRequest.env_for('/foo'))
+      ).to match %r{GET:/foo}
+    end
+  end
+end

data/spec/limiter_spec.rb

@@ -9,7 +9,7 @@ describe Rack::Berater do
     Rack::Builder.new do
       use Rack::Lint
       run (lambda do |env|
-        [200, {'Content-Type' => 'text/plain'}, ['OK']]
+        [200, {'content-type' => 'text/plain'}, ['OK']]
       end)
     end
   end
@@ -22,8 +22,8 @@ describe Rack::Berater do
 
     it 'has the correct headers' do
       expect(response.headers).to eq({
-        'Content-Type' => 'text/plain',
-        'Content-Length' => '2',
+        'content-type' => 'text/plain',
+        'content-length' => '2',
       })
     end
 
@@ -50,7 +50,7 @@ describe Rack::Berater do
       end
 
       context 'when operating beyond limits' do
-        before { Berater.test_mode = :fail }
+        let(:limiter) { ::Berater::Inhibitor.new }
 
         it 'returns an error' do
           expect(response.status).to eq 429
@@ -59,8 +59,7 @@ describe Rack::Berater do
     end
 
     context 'when limiter is a proc' do
-      let(:limiter_instance) { ::Berater::Unlimiter.new }
-      let(:limiter) { Proc.new { limiter_instance } }
+      let(:limiter) { Proc.new { ::Berater::Unlimiter.new } }
 
       include_examples 'works nominally'
 
@@ -70,7 +69,7 @@ describe Rack::Berater do
       end
 
       context 'when operating beyond limits' do
-        before { Berater.test_mode = :fail }
+        let(:limiter) { Proc.new { ::Berater::Inhibitor.new } }
 
         it 'returns an error' do
           expect(response.status).to eq 429

data/spec/prioritizer_spec.rb

@@ -1,10 +1,8 @@
 describe Rack::Berater::Prioritizer do
-  let(:cache) { described_class.class_variable_get(:@@cache) }
-
   describe '#call' do
     subject { described_class.new(app) }
 
-    let(:app) { ->(*) { [200, {'Content-Type' => 'text/plain'}, ['OK']] } }
+    let(:app) { ->(*) { [200, {'content-type' => 'text/plain'}, ['OK']] } }
     let(:cache_key) { subject.send(:cache_key_for, env) }
     let(:env) { Rack::MockRequest.env_for('/') }
 
@@ -30,7 +28,7 @@ describe Rack::Berater::Prioritizer do
       after { subject.call(env) }
 
       it 'sets the priority accordingly' do
-        is_expected.to receive(:set_priority).with(priority)
+        is_expected.to receive(:priority=).with(priority)
       end
 
       it 'updates the global priority during the request' do
@@ -57,12 +55,12 @@ describe Rack::Berater::Prioritizer do
       after { subject.call(env) }
 
       it 'uses the header' do
-        is_expected.to receive(:set_priority).with(priority)
+        is_expected.to receive(:priority=).with(priority)
       end
 
       it 'ignores any cached value' do
         allow(subject).to receive(:cache_get).with(cache_key).and_return('123')
-        is_expected.to receive(:set_priority).with(priority)
+        is_expected.to receive(:priority=).with(priority)
       end
 
       it 'resets the priority after the request completes' do
@@ -100,6 +98,21 @@ describe Rack::Berater::Prioritizer do
       end
     end
 
+    context 'when the app returns a lowercase priority header, per Rack 3' do
+      let(:app) do
+        ->(*) { [200, { described_class::HEADER.downcase => priority }, ['OK']] }
+      end
+
+      let(:priority) { '5' }
+
+      it 'caches the priority and removes the header' do
+        is_expected.to receive(:cache_set).with(cache_key, priority)
+
+        _, headers, _ = subject.call(env)
+        expect(headers).to be_empty
+      end
+    end
+
     it 'does not update the cache when no priority is returned' do
       is_expected.not_to receive(:cache_set)
       subject.call(env)
@@ -113,7 +126,7 @@ describe Rack::Berater::Prioritizer do
       let(:env) { Rack::MockRequest.env_for('/') }
 
       it 'combines the verb and path' do
-        is_expected.to match %r{get:/$}
+        is_expected.to match %r{GET:/$}
       end
     end
 
@@ -121,7 +134,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
 
@@ -129,7 +142,7 @@ describe Rack::Berater::Prioritizer do
       let(:env) { Rack::MockRequest.env_for('/user/123') }
 
       it 'normalizes the id' do
-        is_expected.to match %r{get:/user/x$}
+        is_expected.to match %r{GET:/user/x$}
       end
     end
 
@@ -137,7 +150,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{get:/user/x/$}
+        is_expected.to match %r{GET:/user/x/$}
       end
     end
 
@@ -145,7 +158,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{get:/user/x/friend/x$}
+        is_expected.to match %r{GET:/user/x/friend/x$}
       end
     end
   end
@@ -157,7 +170,7 @@ describe Rack::Berater::Prioritizer do
 
     let(:app) do
       headers = {
-        'Content-Type' => 'text/plain',
+        'content-type' => 'text/plain',
         described_class::HEADER => app_priority,
       }.compact
 
@@ -188,7 +201,6 @@ describe Rack::Berater::Prioritizer do
 
       it 'parses the priority returned from the app' do
         expect(call).to be_empty
-        expect(cache.values).to include app_priority
       end
 
       it 'uses the cached priority for subsequent calls' do
@@ -196,18 +208,5 @@ describe Rack::Berater::Prioritizer do
         expect(call).to eq app_priority
       end
     end
-
-    # context 'when two different endpoints are called' do
-    #   fit 'parses and caches each priority' do
-    #     @app_priority = '6'
-    #     expect(call('/six')).to be_empty
-
-    #     expect(call('/six')).to eq '6'
-
-    #     @app_priority = '9'
-    #     expect(call('/nine')).to be_empty
-    #     expect(call('/nine')).to '9'
-    #   end
-    # end
   end
 end

data/spec/rails_prioritizer_spec.rb

@@ -1,5 +1,3 @@
-require 'rspec/rails'
-
 describe Rack::Berater::RailsPrioritizer do
   before do
     class EchoController < ActionController::Base
@@ -35,13 +33,6 @@ describe Rack::Berater::RailsPrioritizer do
   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) }
@@ -63,13 +54,13 @@ describe Rack::Berater::RailsPrioritizer do
     it 'falls back to Rack style names' do
       expect(
         subject.call(Rack::MockRequest.env_for('/nine'))
-      ).to match %r{get:/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}
+      ).to match %r{GET:/redirect}
     end
   end
 

data/spec/rails_spec.rb

@@ -0,0 +1,39 @@
+require 'rspec/rails'
+
+describe Rack::Berater do
+  before do
+    class OkController < ActionController::Base
+      around_action :limit
+
+      def limit(&block)
+        Berater(:key, 1) { yield }
+      end
+
+      def index
+        head :ok
+      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 '/' => 'ok#index'
+    end
+  end
+
+  let(:app) { Rails.application }
+
+  it { expect(get('/')).to be_ok }
+
+  context 'when past limits' do
+    before { Berater.test_mode = :fail }
+
+    it { expect(get('/').status).to be 429 }
+  end
+end

data/spec/rescuer_spec.rb

@@ -3,8 +3,8 @@ describe Rack::Berater do
     Rack::Builder.new do
       use Rack::Lint
       run (lambda do |env|
-        Berater::Unlimiter() do
-          [200, {'Content-Type' => 'text/plain'}, ['OK']]
+        Berater(:key, 1) do
+          [200, {'content-type' => 'text/plain'}, ['OK']]
         end
       end)
     end
@@ -18,8 +18,8 @@ describe Rack::Berater do
 
     it 'has the correct headers' do
       expect(response.headers).to eq({
-        'Content-Type' => 'text/plain',
-        'Content-Length' => '2',
+        'content-type' => 'text/plain',
+        'content-length' => '2',
       })
     end
 

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: rack-berater
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Daniel Pepper
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-11-18 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: berater
@@ -39,7 +38,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: byebug
+  name: debug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,7 +52,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: codecov
+  name: graphql
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -86,14 +85,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '7'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -128,37 +127,38 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1'
 description: limit incoming requests
-email:
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - lib/rack-berater.rb
 - lib/rack/berater.rb
+- lib/rack/berater/graphql_prioritizer.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/graphql_prioritizer_spec.rb
 - spec/limiter_spec.rb
 - spec/prioritizer_spec.rb
 - spec/rails_prioritizer_spec.rb
+- spec/rails_spec.rb
 - spec/railtie_spec.rb
 - spec/rescuer_spec.rb
 homepage: https://github.com/dpep/rack-berater
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -166,20 +166,21 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Rack::Berater
 test_files:
+- spec/graphql_prioritizer_spec.rb
+- spec/limiter_spec.rb
+- spec/prioritizer_spec.rb
 - spec/rails_prioritizer_spec.rb
+- spec/rails_spec.rb
 - spec/railtie_spec.rb
 - spec/rescuer_spec.rb
-- spec/prioritizer_spec.rb
-- spec/limiter_spec.rb