airbrake-ruby 2.5.0.rc.2 → 2.5.0.rc.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9aff45eea602c2f6f86609e6625146b33f91aa33
-  data.tar.gz: 51c9fb9f2f4e8d5df50832fbbfca92fda7e54239
+  metadata.gz: 313672bde1f31342c0fce790b1f6285c9b125b4e
+  data.tar.gz: 505361aa89c2f456b91ae53c76a73b61cb180838
 SHA512:
-  metadata.gz: e7f2bf4d0415c18bb4385f612f7ca55ea2a8ee83259ee800dc058299e8f51ae1b51ec3c3467156a81547d2d1ad70d5717f1e6c01b53b6012f6a58a1cb141738c
-  data.tar.gz: a8f8a22d199ad6326812daca779c664c53b83c65cc772e370d5cb7ae0a1fb92a65df5b8a33ad8645880571be5ca9f85f44cb030747c4c8ec2ae7e999102d53eb
+  metadata.gz: 65b85420d818a1ab8a4149ca642710c316626d7b283a24a2bb78712f8aa731dfd5946f88da6ab674d69037c50390b726fcc183007156189b3d9bb26c3143b2fb
+  data.tar.gz: 8fcbf41b9f55a93ec262525d39d282f08a8dd2b73a4d96f87e084b440d349b8cf4347e3a48181419906af93ee2bda6b3ff34997af5aa62f8065aed4e90777da9

data/lib/airbrake-ruby/backtrace.rb

@@ -96,6 +96,10 @@ module Airbrake
       EXECJS_SIMPLIFIED = /\A.+ \(.+:\d+:\d+\)\z/
     end
 
+    ##
+    # @return [Integer] how many first frames should include code hunks
+    CODE_FRAME_LIMIT = 10
+
     ##
     # Parses an exception's backtrace.
     #
@@ -104,22 +108,7 @@ module Airbrake
     # @return [Array<Hash{Symbol=>String,Integer}>] the parsed backtrace
     def self.parse(config, exception)
       return [] if exception.backtrace.nil? || exception.backtrace.none?
-
-      regexp = best_regexp_for(exception)
-
-      exception.backtrace.map do |stackframe|
-        frame = match_frame(regexp, stackframe)
-
-        unless frame
-          config.logger.error(
-            "can't parse '#{stackframe}' (please file an issue so we can fix " \
-            "it: https://github.com/airbrake/airbrake-ruby/issues/new)"
-          )
-          frame = { file: nil, line: nil, function: stackframe }
-        end
-
-        stack_frame(config, frame)
-      end
+      parse_backtrace(config, exception)
     end
 
     ##
@@ -176,15 +165,12 @@ module Airbrake
       end
       # rubocop:enable Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity
 
-      def stack_frame(config, match)
-        frame = {
+      def stack_frame(match)
+        {
           file: match[:file],
           line: (Integer(match[:line]) if match[:line]),
           function: match[:function]
         }
-
-        populate_code(config, frame) if config.code_hunks
-        frame
       end
 
       def match_frame(regexp, stackframe)
@@ -194,6 +180,33 @@ module Airbrake
         Patterns::GENERIC.match(stackframe)
       end
 
+      def parse_backtrace(config, exception)
+        regexp = best_regexp_for(exception)
+
+        exception.backtrace.map.with_index do |stackframe, i|
+          unless (match = match_frame(regexp, stackframe))
+            config.logger.error(
+              "can't parse '#{stackframe}' (please file an issue so we can fix " \
+              "it: https://github.com/airbrake/airbrake-ruby/issues/new)"
+            )
+            match = { file: nil, line: nil, function: stackframe }
+          end
+
+          frame = stack_frame(match)
+          next(frame) unless config.code_hunks
+
+          if config.root_directory
+            if frame[:file].start_with?(config.root_directory)
+              populate_code(config, frame)
+            end
+          elsif i < CODE_FRAME_LIMIT
+            populate_code(config, frame)
+          end
+
+          frame
+        end
+      end
+
       def populate_code(config, frame)
         code = Airbrake::CodeHunk.new(config).get(frame[:file], frame[:line])
         frame[:code] = code if code

data/lib/airbrake-ruby/version.rb

@@ -4,5 +4,5 @@
 module Airbrake
   ##
   # @return [String] the library version
-  AIRBRAKE_RUBY_VERSION = '2.5.0.rc.2'.freeze
+  AIRBRAKE_RUBY_VERSION = '2.5.0.rc.3'.freeze
 end

data/spec/backtrace_spec.rb

@@ -297,29 +297,98 @@ RSpec.describe Airbrake::Backtrace do
         config
       end
 
-      let(:parsed_backtrace) do
-        [
-          {
-            file: File.join(fixture_path('code.rb')),
-            line: 94,
-            function: 'to_json',
-            code: {
-              92 => '      loop do',
-              93 => '        begin',
-              94 => '          json = @payload.to_json',
-              95 => '        rescue *JSON_EXCEPTIONS => ex',
-              # rubocop:disable Metrics/LineLength,Lint/InterpolationCheck
-              96 => '          @config.logger.debug("#{LOG_LABEL} `notice.to_json` failed: #{ex.class}: #{ex}")',
-              # rubocop:enable Metrics/LineLength,Lint/InterpolationCheck
+      context "and when root_directory is configured" do
+        before { config.root_directory = project_root_path('') }
+
+        let(:parsed_backtrace) do
+          [
+            {
+              file: project_root_path('code.rb'),
+              line: 94,
+              function: 'to_json',
+              code: {
+                92 => '      loop do',
+                93 => '        begin',
+                94 => '          json = @payload.to_json',
+                95 => '        rescue *JSON_EXCEPTIONS => ex',
+                # rubocop:disable Metrics/LineLength,Lint/InterpolationCheck
+                96 => '          @config.logger.debug("#{LOG_LABEL} `notice.to_json` failed: #{ex.class}: #{ex}")',
+                # rubocop:enable Metrics/LineLength,Lint/InterpolationCheck
+              }
+            },
+            {
+              file: fixture_path('notroot.txt'),
+              line: 3,
+              function: 'pineapple'
             }
-          }
-        ]
+          ]
+        end
+
+        it "attaches code to those frames files of which match root_directory" do
+          ex = RuntimeError.new
+          backtrace = [
+            project_root_path('code.rb') + ":94:in `to_json'",
+            fixture_path('notroot.txt' + ":3:in `pineapple'")
+          ]
+          ex.set_backtrace(backtrace)
+          expect(described_class.parse(config, ex)).to eq(parsed_backtrace)
+        end
       end
 
-      it "attaches code to each frame" do
-        ex = RuntimeError.new
-        ex.set_backtrace([File.join(fixture_path('code.rb') + ":94:in `to_json'")])
-        expect(described_class.parse(config, ex)).to eq(parsed_backtrace)
+      context "and when root_directory isn't configured" do
+        before do
+          config.root_directory = nil
+          stub_const('Airbrake::Backtrace::CODE_FRAME_LIMIT', 2)
+        end
+
+        let(:parsed_backtrace) do
+          [
+            {
+              file: project_root_path('code.rb'),
+              line: 94,
+              function: 'to_json',
+              code: {
+                92 => '      loop do',
+                93 => '        begin',
+                94 => '          json = @payload.to_json',
+                95 => '        rescue *JSON_EXCEPTIONS => ex',
+                # rubocop:disable Metrics/LineLength,Lint/InterpolationCheck
+                96 => '          @config.logger.debug("#{LOG_LABEL} `notice.to_json` failed: #{ex.class}: #{ex}")',
+                # rubocop:enable Metrics/LineLength,Lint/InterpolationCheck
+              }
+            },
+            {
+              file: project_root_path('code.rb'),
+              line: 95,
+              function: 'to_json',
+              code: {
+                93 => '        begin',
+                94 => '          json = @payload.to_json',
+                95 => '        rescue *JSON_EXCEPTIONS => ex',
+                # rubocop:disable Metrics/LineLength,Lint/InterpolationCheck
+                96 => '          @config.logger.debug("#{LOG_LABEL} `notice.to_json` failed: #{ex.class}: #{ex}")',
+                # rubocop:enable Metrics/LineLength,Lint/InterpolationCheck
+                97 => '        else'
+              }
+            },
+            {
+              file: project_root_path('code.rb'),
+              line: 96,
+              function: 'to_json'
+            }
+          ]
+        end
+
+        it "attaches code to first N frames" do
+          ex = RuntimeError.new
+          backtrace = [
+            project_root_path('code.rb') + ":94:in `to_json'",
+            project_root_path('code.rb') + ":95:in `to_json'",
+            project_root_path('code.rb') + ":96:in `to_json'"
+          ]
+          ex.set_backtrace(backtrace)
+          expect(described_class.parse(config, ex)).to eq(parsed_backtrace)
+        end
       end
     end
   end

data/spec/code_hunk_spec.rb

@@ -5,33 +5,33 @@ RSpec.describe Airbrake::CodeHunk do
 
   after do
     %w[empty_file.rb code.rb banana.rb short_file.rb long_line.txt].each do |f|
-      Airbrake::FileCache[fixture_path(f)] = nil
+      Airbrake::FileCache[project_root_path(f)] = nil
     end
   end
 
   describe "#to_h" do
     context "when file is empty" do
       subject do
-        described_class.new(config).get(fixture_path('empty_file.rb'), 1)
+        described_class.new(config).get(project_root_path('empty_file.rb'), 1)
       end
 
       it { is_expected.to eq(1 => '') }
     end
 
     context "when line is nil" do
-      subject { described_class.new(config).get(fixture_path('code.rb'), nil) }
+      subject { described_class.new(config).get(project_root_path('code.rb'), nil) }
 
       it { is_expected.to be_nil }
     end
 
     context "when a file doesn't exist" do
-      subject { described_class.new(config).get(fixture_path('banana.rb'), 1) }
+      subject { described_class.new(config).get(project_root_path('banana.rb'), 1) }
 
       it { is_expected.to be_nil }
     end
 
     context "when a file has less than NLINES lines before start line" do
-      subject { described_class.new(config).get(fixture_path('code.rb'), 1) }
+      subject { described_class.new(config).get(project_root_path('code.rb'), 1) }
 
       it do
         is_expected.to(
@@ -47,7 +47,7 @@ RSpec.describe Airbrake::CodeHunk do
     end
 
     context "when a file has less than NLINES lines after end line" do
-      subject { described_class.new(config).get(fixture_path('code.rb'), 222) }
+      subject { described_class.new(config).get(project_root_path('code.rb'), 222) }
 
       it do
         is_expected.to(
@@ -61,7 +61,7 @@ RSpec.describe Airbrake::CodeHunk do
 
     context "when a file has less than NLINES lines before and after" do
       subject do
-        described_class.new(config).get(fixture_path('short_file.rb'), 2)
+        described_class.new(config).get(project_root_path('short_file.rb'), 2)
       end
 
       it do
@@ -76,7 +76,7 @@ RSpec.describe Airbrake::CodeHunk do
     end
 
     context "when a file has enough lines before and after" do
-      subject { described_class.new(config).get(fixture_path('code.rb'), 100) }
+      subject { described_class.new(config).get(project_root_path('code.rb'), 100) }
 
       it do
         is_expected.to(
@@ -93,7 +93,7 @@ RSpec.describe Airbrake::CodeHunk do
 
     context "when a line exceeds the length limit" do
       subject do
-        described_class.new(config).get(fixture_path('long_line.txt'), 1)
+        described_class.new(config).get(project_root_path('long_line.txt'), 1)
       end
 
       it "strips the line" do
@@ -110,7 +110,7 @@ RSpec.describe Airbrake::CodeHunk do
         out = StringIO.new
         config = Airbrake::Config.new
         config.logger = Logger.new(out)
-        expect(described_class.new(config).get(fixture_path('code.rb'), 1)).to(
+        expect(described_class.new(config).get(project_root_path('code.rb'), 1)).to(
           eq(1 => '')
         )
         expect(out.string).to match(/can't read code hunk.+Permission denied/)

data/spec/fixtures/notroot.txt

@@ -0,0 +1,7 @@
+This
+file
+is
+not
+inside
+root
+directory

data/spec/helpers.rb

@@ -2,4 +2,8 @@ module Helpers
   def fixture_path(filename)
     File.expand_path(File.join('spec', 'fixtures', filename))
   end
+
+  def project_root_path(filename)
+    fixture_path(File.join('project_root', filename))
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: airbrake-ruby
 version: !ruby/object:Gem::Version
-  version: 2.5.0.rc.2
+  version: 2.5.0.rc.3
 platform: ruby
 authors:
 - Airbrake Technologies, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-18 00:00:00.000000000 Z
+date: 2017-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -80,20 +80,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.50'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.50'
 - !ruby/object:Gem::Dependency
   name: public_suffix
   requirement: !ruby/object:Gem::Requirement
@@ -166,10 +152,11 @@ files:
 - spec/filters/root_directory_filter_spec.rb
 - spec/filters/system_exit_filter_spec.rb
 - spec/filters/thread_filter_spec.rb
-- spec/fixtures/code.rb
-- spec/fixtures/empty_file.rb
-- spec/fixtures/long_line.txt
-- spec/fixtures/short_file.rb
+- spec/fixtures/notroot.txt
+- spec/fixtures/project_root/code.rb
+- spec/fixtures/project_root/empty_file.rb
+- spec/fixtures/project_root/long_line.txt
+- spec/fixtures/project_root/short_file.rb
 - spec/helpers.rb
 - spec/nested_exception_spec.rb
 - spec/notice_spec.rb
@@ -218,10 +205,11 @@ test_files:
 - spec/filters/root_directory_filter_spec.rb
 - spec/filters/system_exit_filter_spec.rb
 - spec/filters/thread_filter_spec.rb
-- spec/fixtures/code.rb
-- spec/fixtures/empty_file.rb
-- spec/fixtures/long_line.txt
-- spec/fixtures/short_file.rb
+- spec/fixtures/notroot.txt
+- spec/fixtures/project_root/code.rb
+- spec/fixtures/project_root/empty_file.rb
+- spec/fixtures/project_root/long_line.txt
+- spec/fixtures/project_root/short_file.rb
 - spec/helpers.rb
 - spec/nested_exception_spec.rb
 - spec/notice_spec.rb