Implement code hunks support

lib/airbrake-ruby.rb

@@ -25,6 +25,7 @@
 require 'airbrake-ruby/filters/thread_filter'
 require 'airbrake-ruby/filter_chain'
 require 'airbrake-ruby/notifier'
+require 'airbrake-ruby/code_hunk'
 
 ##
 # This module defines the Airbrake API. The user is meant to interact with

lib/airbrake-ruby/backtrace.rb

@@ -102,7 +102,7 @@ module Patterns
     # @param [Exception] exception The exception, which contains a backtrace to
     #   parse
     # @return [Array<Hash{Symbol=>String,Integer}>] the parsed backtrace
-    def self.parse(exception, logger)
+    def self.parse(config, exception)
       return [] if exception.backtrace.nil? || exception.backtrace.none?
 
       regexp = best_regexp_for(exception)
@@ -111,14 +111,14 @@ def self.parse(exception, logger)
         frame = match_frame(regexp, stackframe)
 
         unless frame
-          logger.error(
+          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(frame)
+        stack_frame(config, frame)
       end
     end
 
@@ -176,10 +176,15 @@ def execjs_exception?(exception)
       end
       # rubocop:enable Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity
 
-      def stack_frame(match)
-        { file: match[:file],
+      def stack_frame(config, match)
+        frame = {
+          file: match[:file],
           line: (Integer(match[:line]) if match[:line]),
-          function: match[:function] }
+          function: match[:function]
+        }
+
+        populate_code(config, frame) if config.code_hunks
+        frame
       end
 
       def match_frame(regexp, stackframe)
@@ -188,6 +193,11 @@ def match_frame(regexp, stackframe)
 
         Patterns::GENERIC.match(stackframe)
       end
+
+      def populate_code(config, frame)
+        code = Airbrake::CodeHunk.new(config).get(frame[:file], frame[:line])
+        frame[:code] = code if code
+      end
     end
   end
 end

lib/airbrake-ruby/code_hunk.rb

@@ -0,0 +1,48 @@
+module Airbrake
+  ##
+  # Represents a small hunk of code consisting of a base line and a couple lines
+  # around it
+  # @api private
+  class CodeHunk
+    ##
+    # @return [Integer] the maximum length of a line
+    MAX_LINE_LEN = 200
+
+    ##
+    # @return [Integer] how many lines should be read around the base line
+    NLINES = 2
+
+    def initialize(config)
+      @config = config
+    end
+
+    ##
+    # @param [String] file The file to read
+    # @param [Integer] line The base line in the file
+    # @return [Hash{Integer=>String}, nil] lines of code around the base line
+    def get(file, line)
+      return unless File.exist?(file)
+
+      start_line = [line - NLINES, 1].max
+      end_line = line + NLINES
+      lines = {}
+
+      begin
+        File.foreach(file).with_index(1) do |l, i|
+          next if i < start_line
+          break if i > end_line
+
+          lines[i] = l[0...MAX_LINE_LEN].rstrip
+        end
+      rescue StandardError => ex
+        @config.logger.error(
+          "#{self.class.name}##{__method__}: can't read code hunk for " \
+          "#{file}:#{line}: #{ex}"
+        )
+      end
+
+      return { 1 => '' } if lines.empty?
+      lines
+    end
+  end
+end

lib/airbrake-ruby/config.rb

@@ -72,6 +72,12 @@ class Config
     # @since 1.2.0
     attr_accessor :whitelist_keys
 
+    ##
+    # @return [Boolean] true if the library should attach code hunks to each
+    #   frame in a backtrace, false otherwise
+    # @since v3.0.0
+    attr_accessor :code_hunks
+
     ##
     # @param [Hash{Symbol=>Object}] user_config the hash to be used to build the
     #   config
@@ -81,6 +87,7 @@ def initialize(user_config = {})
       self.proxy = {}
       self.queue_size = 100
       self.workers = 1
+      self.code_hunks = false
 
       self.logger = Logger.new(STDOUT)
       logger.level = Logger::WARN

lib/airbrake-ruby/nested_exception.rb

@@ -11,16 +11,16 @@ class NestedException
     #   can unwrap. Exceptions that have a longer cause chain will be ignored
     MAX_NESTED_EXCEPTIONS = 3
 
-    def initialize(exception, logger)
+    def initialize(config, exception)
+      @config = config
       @exception = exception
-      @logger = logger
     end
 
     def as_json
       unwind_exceptions.map do |exception|
         { type: exception.class.name,
           message: exception.message,
-          backtrace: Backtrace.parse(exception, @logger) }
+          backtrace: Backtrace.parse(@config, exception) }
       end
     end
 

lib/airbrake-ruby/notice.rb

@@ -68,7 +68,7 @@ def initialize(config, exception, params = {})
       @config = config
 
       @payload = {
-        errors: NestedException.new(exception, @config.logger).as_json,
+        errors: NestedException.new(config, exception).as_json,
         context: context,
         environment: {
           program_name: $PROGRAM_NAME

spec/backtrace_spec.rb

@@ -1,6 +1,10 @@
 require 'spec_helper'
 
 RSpec.describe Airbrake::Backtrace do
+  let(:config) do
+    Airbrake::Config.new.tap { |c| c.logger = Logger.new('/dev/null') }
+  end
+
   describe ".parse" do
     context "UNIX backtrace" do
       let(:parsed_backtrace) do
@@ -23,7 +27,7 @@
 
       it "returns a properly formatted array of hashes" do
         expect(
-          described_class.parse(AirbrakeTestError.new, Logger.new('/dev/null'))
+          described_class.parse(config, AirbrakeTestError.new)
         ).to eq(parsed_backtrace)
       end
     end
@@ -44,9 +48,7 @@
       end
 
       it "returns a properly formatted array of hashes" do
-        expect(
-          described_class.parse(ex, Logger.new('/dev/null'))
-        ).to eq(parsed_backtrace)
+        expect(described_class.parse(config, ex)).to eq(parsed_backtrace)
       end
     end
 
@@ -71,7 +73,7 @@
         allow(described_class).to receive(:java_exception?).and_return(true)
 
         expect(
-          described_class.parse(JavaAirbrakeTestError.new, Logger.new('/dev/null'))
+          described_class.parse(config, JavaAirbrakeTestError.new)
         ).to eq(backtrace_array)
       end
     end
@@ -99,10 +101,7 @@
 
       it "returns a properly formatted array of hashes" do
         allow(described_class).to receive(:java_exception?).and_return(true)
-
-        expect(
-          described_class.parse(ex, Logger.new('/dev/null'))
-        ).to eq(parsed_backtrace)
+        expect(described_class.parse(config, ex)).to eq(parsed_backtrace)
       end
     end
 
@@ -126,9 +125,7 @@
       let(:ex) { AirbrakeTestError.new.tap { |e| e.set_backtrace(backtrace) } }
 
       it "returns a properly formatted array of hashes" do
-        expect(
-          described_class.parse(ex, Logger.new('/dev/null'))
-        ).to eq(parsed_backtrace)
+        expect(described_class.parse(config, ex)).to eq(parsed_backtrace)
       end
     end
 
@@ -153,9 +150,7 @@
         end
 
         it "returns a properly formatted array of hashes" do
-          expect(
-            described_class.parse(ex, Logger.new('/dev/null'))
-          ).to eq(parsed_backtrace)
+          expect(described_class.parse(config, ex)).to eq(parsed_backtrace)
         end
       end
 
@@ -173,9 +168,7 @@
         end
 
         it "returns a properly formatted array of hashes" do
-          expect(
-            described_class.parse(ex, Logger.new('/dev/null'))
-          ).to eq(parsed_backtrace)
+          expect(described_class.parse(config, ex)).to eq(parsed_backtrace)
         end
       end
     end
@@ -187,15 +180,15 @@
 
       it "returns array of hashes where each unknown frame is marked as 'function'" do
         expect(
-          described_class.parse(ex, Logger.new('/dev/null'))
+          described_class.parse(config, ex)
         ).to eq([file: nil, line: nil, function: 'a b c 1 23 321 .rb'])
       end
 
       it "logs unknown frames as errors" do
         out = StringIO.new
-        logger = Logger.new(out)
+        config.logger = Logger.new(out)
 
-        expect { described_class.parse(ex, logger) }.
+        expect { described_class.parse(config, ex) }.
           to change { out.string }.
           from('').
           to(/ERROR -- : can't parse 'a b c 1 23 321 .rb'/)
@@ -216,9 +209,7 @@
       end
 
       it "returns a properly formatted array of hashes" do
-        expect(
-          described_class.parse(ex, Logger.new('/dev/null'))
-        ).to eq(parsed_backtrace)
+        expect(described_class.parse(config, ex)).to eq(parsed_backtrace)
       end
     end
 
@@ -241,9 +232,7 @@
 
       it "returns a properly formatted array of hashes" do
         stub_const('OCIError', AirbrakeTestError)
-        expect(
-          described_class.parse(ex, Logger.new('/dev/null'))
-        ).to eq(parsed_backtrace)
+        expect(described_class.parse(config, ex)).to eq(parsed_backtrace)
       end
     end
 
@@ -279,9 +268,7 @@
           stub_const('ExecJS::RuntimeError', AirbrakeTestError)
           stub_const('Airbrake::RUBY_20', false)
 
-          expect(
-            described_class.parse(ex, Logger.new('/dev/null'))
-          ).to eq(parsed_backtrace)
+          expect(described_class.parse(config, ex)).to eq(parsed_backtrace)
         end
       end
 
@@ -296,12 +283,44 @@
             stub_const('ExecJS::RuntimeError', NameError)
             stub_const('Airbrake::RUBY_20', true)
 
-            expect(
-              described_class.parse(ex, Logger.new('/dev/null'))
-            ).to eq(parsed_backtrace)
+            expect(described_class.parse(config, ex)).to eq(parsed_backtrace)
           end
         end
       end
     end
+
+    context "when code hunks are enabled" do
+      let(:config) do
+        config = Airbrake::Config.new
+        config.logger = Logger.new('/dev/null')
+        config.code_hunks = true
+        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
+            }
+          }
+        ]
+      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)
+      end
+    end
   end
 end