airbrake 7.4.0 → 7.5.0.pre.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ac1ef23c5180983961f8a55e150443cb90ec92aa
-  data.tar.gz: ed676f689b5b7fc965a7235f8b7c114ada734079
+  metadata.gz: daaa847e504e6c5ce90d20d14abbfe22673742c8
+  data.tar.gz: bf1064650bc6e0ea0ac33913bb8f1ec27b914b8a
 SHA512:
-  metadata.gz: ebd1afea0eece28fe5e8b1bdd63e886f48e8150d6a2bf2a504aa1fac7f9f60c75b65483335be73b729d5f6ce9dc4b7b7bad71a60a0d311dba0d9df39182edf4b
-  data.tar.gz: 8268bbc33ec9bbbfd9f1a33de99afe3c45d0aedff28a131a902dc739b065004d1295d0ed8be57687e60f8ce8c0954a1cc1bdeebcd315f4b1c4766022c050be82
+  metadata.gz: e9ca5aab85564501b4035eae6d3263c8ce2d0b3d2353b04326d9aa7c1c8538d5a2c226055b04a46c33b4e5c7260e6527ce89a34d5544a7e34371304118c0c269
+  data.tar.gz: 2b04e5b8828ae024ea513c0e8189f95490bdacdbaa9b511d121a8691f921de756968bde759e28673eb53feb5c477aac7d02896657ca5d23d5b6b984779d1a929

data/lib/airbrake/rack.rb

@@ -4,4 +4,5 @@ require 'airbrake/rack/session_filter'
 require 'airbrake/rack/http_params_filter'
 require 'airbrake/rack/http_headers_filter'
 require 'airbrake/rack/request_body_filter'
+require 'airbrake/rack/route_filter'
 require 'airbrake/rack/middleware'

data/lib/airbrake/rack/middleware.rb

@@ -6,6 +6,8 @@ module Airbrake
     #
     # The middleware automatically sends information about the framework that
     # uses it (name and version).
+    #
+    # For Rails apps the middleware collects route performance statistics.
     class Middleware
       # @return [Array<Class>] the list of Rack filters that read Rack request
       #   information and append it to notices
@@ -13,7 +15,8 @@ module Airbrake
         Airbrake::Rack::ContextFilter,
         Airbrake::Rack::SessionFilter,
         Airbrake::Rack::HttpParamsFilter,
-        Airbrake::Rack::HttpHeadersFilter
+        Airbrake::Rack::HttpHeadersFilter,
+        Airbrake::Rack::RouteFilter,
 
         # Optional filters (must be included by users):
         # Airbrake::Rack::RequestBodyFilter
@@ -37,6 +40,9 @@ module Airbrake
         RACK_FILTERS.each do |filter|
           @notifier.add_filter(filter.new)
         end
+
+        return unless defined?(Rails)
+        subscribe_route_stats_hook
       end
 
       # Rescues any exceptions, sends them to Airbrake and re-raises the
@@ -69,6 +75,8 @@ module Airbrake
         notice.stash[:rack_request] =
           if defined?(ActionDispatch::Request)
             ActionDispatch::Request.new(env)
+          elsif defined?(Sinatra::Request)
+            Sinatra::Request.new(env)
           else
             ::Rack::Request.new(env)
           end
@@ -87,6 +95,50 @@ module Airbrake
           env['sinatra.error'] ||
           env['rack.exception']
       end
+
+      def subscribe_route_stats_hook
+        ActiveSupport::Notifications.subscribe(
+          'process_action.action_controller'
+        ) do |*args|
+          @all_routes ||= find_all_routes
+
+          event = ActiveSupport::Notifications::Event.new(*args)
+          payload = event.payload
+
+          if (route = find_route(payload[:params]))
+            @notifier.inc_request(
+              payload[:method],
+              route,
+              payload[:status],
+              event.duration,
+              event.time
+            )
+          else
+            @config.logger.info(
+              "#{LOG_LABEL} Rack::Middleware#route_stats_hook: couldn't find " \
+              "a route for path: #{payload[:path]}"
+            )
+          end
+        end
+      end
+
+      def find_route(params)
+        @all_routes.each do |r|
+          if r.defaults[:controller] == params['controller'] &&
+             r.defaults[:action] == params['action']
+            return r.path.spec.to_s
+          end
+        end
+      end
+
+      # Finds all routes that the app supports, including engines.
+      def find_all_routes
+        routes = [*::Rails.application.routes.routes.routes]
+        ::Rails::Engine.subclasses.each do |engine|
+          routes.push(*engine.routes.routes.routes)
+        end
+        routes
+      end
     end
   end
 end

data/lib/airbrake/rack/route_filter.rb

@@ -0,0 +1,45 @@
+module Airbrake
+  module Rack
+    # Adds route slugs to context/route.
+    # @since v7.5.0
+    class RouteFilter
+      attr_reader :weight
+
+      def initialize
+        @weight = 100
+      end
+
+      def call(notice)
+        return unless (request = notice.stash[:rack_request])
+
+        notice[:context][:route] =
+          if defined?(ActionDispatch::Request) &&
+             request.instance_of?(ActionDispatch::Request)
+            rails_route(request)
+          elsif defined?(Sinatra::Request) &&
+                request.instance_of?(Sinatra::Request)
+            sinatra_route(request)
+          end
+      end
+
+      private
+
+      def rails_route(request)
+        ::Rails.application.routes.router.recognize(request) do |route, _parameters|
+          # Rails can recognize multiple routes for the given request. For
+          # example, if we visit /users/2/edit, then Rails sees these routes:
+          #   * "/users/:id/edit(.:format)"
+          #   *  "/"
+          #
+          # We return the first route as, what it seems, the most optimal
+          # approach.
+          return route.path.spec.to_s
+        end
+      end
+
+      def sinatra_route(request)
+        request.env['sinatra.route'].split(' ').drop(1).join(' ')
+      end
+    end
+  end
+end

data/lib/airbrake/version.rb

@@ -1,5 +1,5 @@
 # We use Semantic Versioning v2.0.0
 # More information: http://semver.org/
 module Airbrake
-  AIRBRAKE_VERSION = '7.4.0'.freeze
+  AIRBRAKE_VERSION = '7.5.0.pre.1'.freeze
 end

data/spec/integration/rails/rails_spec.rb

@@ -8,6 +8,12 @@ RSpec.describe "Rails integration specs" do
 
   include_examples 'rack examples'
 
+  # Airbrake Ruby has a background thread that sends requests to
+  # `/routes-stats` periodically. We don't want this to get in the way.
+  before do
+    allow(Airbrake[:default]).to receive(:inc_request).and_return(nil)
+  end
+
   if ::Rails.version.start_with?('5.')
     it "inserts the Airbrake Rack middleware after DebugExceptions" do
       middlewares = Rails.configuration.middleware.middlewares.map(&:inspect)
@@ -68,6 +74,10 @@ RSpec.describe "Rails integration specs" do
         /"context":{.*"params":{.*"controller":"dummy","action":"#{action}".*}/
       )
     end
+
+    it "includes route" do
+      wait_for_a_request_with_body(/"context":{.*"route":"#{route}\(\.:format\)".*}/)
+    end
   end
 
   describe "context payload" do
@@ -273,4 +283,27 @@ RSpec.describe "Rails integration specs" do
       end
     end
   end
+
+  describe "the route stats hook" do
+    let(:routes_endpoint) do
+      'https://api.airbrake.io/api/v4/projects/113743/routes-stats'
+    end
+
+    before do
+      stub_request(:put, routes_endpoint).to_return(status: 200, body: '')
+    end
+
+    it "increments the request count" do
+      expect(Airbrake[:default]).to receive(:inc_request).and_call_original
+
+      get '/crash'
+      sleep 2
+
+      wait_for_a_request_with_body(/"errors"/)
+
+      body = %r|{"routes":\[{"method":"GET","route":"\/crash\(\.:format\)"|
+      wait_for(a_request(:put, routes_endpoint).with(body: body)).
+        to have_been_made.once
+    end
+  end
 end

data/spec/integration/rails/rake_spec.rb

@@ -106,7 +106,7 @@ RSpec.describe "Rake integration" do
 
       it "includes argv info" do
         wait_for_a_request_with_body(
-          %r("params":{.*"argv":"--pattern spec/integration/rails/\*_spec.rb".*})
+          %r("params":{.*"argv":".*spec/integration/rails/.+_spec.rb".*})
         )
       end
 

data/spec/integration/sinatra/sinatra_spec.rb

@@ -17,6 +17,11 @@ RSpec.describe "Sinatra integration specs" do
       get '/crash'
       wait_for_a_request_with_body(/"context":{.*"versions":{"sinatra":"\d\./)
     end
+
+    it "includes route" do
+      get '/crash'
+      wait_for_a_request_with_body(%r("context":{.*"route":"\/crash".*}))
+    end
   end
 
   context "when multiple apps are mounted" do

data/spec/spec_helper.rb

@@ -16,6 +16,7 @@ Airbrake.configure do |c|
   c.logger = Logger.new('/dev/null')
   c.app_version = '1.2.3'
   c.workers = 5
+  c.route_stats_flush_period = 1
 end
 
 RSpec.configure do |c|

data/spec/unit/rack/route_filter_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+RSpec.describe Airbrake::Rack::RouteFilter do
+  context "when there's no request object available" do
+    it "doesn't add context/route" do
+      notice = Airbrake.build_notice('oops')
+      subject.call(notice)
+      expect(notice[:context][:route]).to be_nil
+    end
+  end
+end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: airbrake
 version: !ruby/object:Gem::Version
-  version: 7.4.0
+  version: 7.5.0.pre.1
 platform: ruby
 authors:
 - Airbrake Technologies, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-11 00:00:00.000000000 Z
+date: 2018-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: airbrake-ruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '2.12'
+        version: 2.13.0.pre.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '2.12'
+        version: 2.13.0.pre.1
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -254,6 +254,7 @@ files:
 - lib/airbrake/rack/http_params_filter.rb
 - lib/airbrake/rack/middleware.rb
 - lib/airbrake/rack/request_body_filter.rb
+- lib/airbrake/rack/route_filter.rb
 - lib/airbrake/rack/session_filter.rb
 - lib/airbrake/rack/user.rb
 - lib/airbrake/rails.rb
@@ -288,6 +289,7 @@ files:
 - spec/unit/rack/http_params_filter_spec.rb
 - spec/unit/rack/middleware_spec.rb
 - spec/unit/rack/request_body_filter_spec.rb
+- spec/unit/rack/route_filter_spec.rb
 - spec/unit/rack/session_filter_spec.rb
 - spec/unit/rack/user_spec.rb
 - spec/unit/rake/tasks_spec.rb
@@ -310,9 +312,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.6.13
@@ -335,6 +337,7 @@ test_files:
 - spec/unit/rack/session_filter_spec.rb
 - spec/unit/rack/context_filter_spec.rb
 - spec/unit/rack/user_spec.rb
+- spec/unit/rack/route_filter_spec.rb
 - spec/integration/sinatra/sinatra_spec.rb
 - spec/integration/rack/rack_spec.rb
 - spec/integration/shared_examples/rack_examples.rb