airbrake_tools 0.0.8 → 0.0.10

data/Gemfile

@@ -1,6 +1,6 @@
 source :rubygems
 gemspec
 
-gem "bump"
+gem "bump", "0.3.8"
 gem "rake"
 gem "rspec", "~>2"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    airbrake_tools (0.0.8)
+    airbrake_tools (0.0.10)
       airbrake-api (>= 4.2.2)
 
 GEM
@@ -13,7 +13,7 @@ GEM
       mash
       multi_xml
       parallel (~> 0.5.0)
-    bump (0.3.5)
+    bump (0.3.8)
     diff-lcs (1.1.3)
     faraday (0.8.4)
       multipart-post (~> 1.1)
@@ -39,6 +39,6 @@ PLATFORMS
 
 DEPENDENCIES
   airbrake_tools!
-  bump
+  bump (= 0.3.8)
   rake
   rspec (~> 2)

data/Readme.md

@@ -50,6 +50,7 @@ Shows all errors divided by pages
 
  - show details for 1 error (combines 150 notices)
  - show all different traces that caused this error (play with --compare-depth)
+ - shows blame for the line if it's in the project and you are running airrake-tools from the project root
 
 ```
 airbrake-tools your-account your-auth-token summary 51344729
@@ -63,7 +64,8 @@ Mysql2::Error: Lost connection to MySQL server at 'reading initial communication
 
 Trace 2: occurred 10 times e.g. 7145613107, 7145612108
 Mysql2::Error: Lost connection to MySQL server
-./mysql2/lib/mysql2/client.rb:58:in `disconnect'
+/usr/gems/mysql2/lib/mysql2/client.rb:58:in `disconnect'
+lib/foo.rb:58:in `bar' acc8204 (<jcheatham@example.com> 2012-11-06 18:45:10 -0800 )
 ...
 
 Trace 3: occurred 5 times e.g. 7145609979, 7145609161

data/lib/airbrake_tools/version.rb

@@ -1,3 +1,3 @@
 module AirbrakeTools
-  VERSION = "0.0.8"
+  VERSION = "0.0.10"
 end

data/lib/airbrake_tools.rb

@@ -6,8 +6,12 @@ module AirbrakeTools
   DEFAULT_HOT_PAGES = 1
   DEFAULT_NEW_PAGES = 1
   DEFAULT_SUMMARY_PAGES = 5
-  DEFAULT_COMPARE_DEPTH = 7
+  DEFAULT_COMPARE_DEPTH_ADDITION = 3 # first line in project is 6 -> compare at 6 + x depth
   DEFAULT_ENVIRONMENT = "production"
+  COLORS = {
+    :gray => "\e[0;37m",
+    :clear => "\e[0m"
+  }
 
   class << self
     def cli(argv)
@@ -63,31 +67,78 @@ module AirbrakeTools
     end
 
     def summary(error_id, options)
-      compare_depth = options[:compare_depth] || DEFAULT_COMPARE_DEPTH
       notices = AirbrakeAPI.notices(error_id, :pages => options[:pages] || DEFAULT_SUMMARY_PAGES)
 
       puts "last retrieved notice: #{((Time.now - notices.last.created_at) / (60 * 60)).round} hours ago at #{notices.last.created_at}"
       puts "last 2 hours:  #{sparkline(notices, :slots => 60, :interval => 120)}"
       puts "last day:      #{sparkline(notices, :slots => 24, :interval => 60 * 60)}"
 
-      backtraces = notices.compact.select{|n| n.backtrace }.group_by do |notice|
-        if notice.backtrace.is_a?(String) # no backtrace recorded...
-          []
-        else
-          notice.backtrace.first[1][0..compare_depth]
-        end
-      end
-
-      backtraces.sort_by{|_,notices| notices.size }.reverse.each_with_index do |(backtrace, notices), index|
+      grouped_backtraces(notices, options).sort_by{|_,notices| notices.size }.reverse.each_with_index do |(backtrace, notices), index|
         puts "Trace #{index + 1}: occurred #{notices.size} times e.g. #{notices[0..5].map(&:id).join(", ")}"
         puts notices.first.error_message
-        puts backtrace.map{|line| line.sub("[PROJECT_ROOT]/", "./") }
+        puts backtrace.map{|line| present_line(line) }
         puts ""
       end
     end
 
     private
 
+    def present_line(line)
+      color = :gray if $stdout.tty? && !custom_file?(line)
+      line = line.sub("[PROJECT_ROOT]/", "")
+      line = add_blame(line)
+      if color
+        "#{COLORS.fetch(color)}#{line}#{COLORS.fetch(:clear)}"
+      else
+        line
+      end
+    end
+
+    def add_blame(backtrace_line)
+      file, line = backtrace_line.split(":", 2)
+      line = line.to_i
+      if not file.start_with?("/") and line > 0 and File.exist?(".git") and File.exist?(file)
+        result = `git blame #{file} -L #{line},#{line} --show-email -w 2>&1`
+        if $?.success?
+          result.sub!(/ #{line}\) .*/, " )") # cut of source code
+          backtrace_line += " -- #{result.strip}"
+        end
+      end
+      backtrace_line
+    end
+
+    def grouped_backtraces(notices, options)
+      notices = notices.compact.select { |n| backtrace(n) }
+
+      compare_depth = if options[:compare_depth]
+        options[:compare_depth]
+      else
+        average_first_project_line(notices.map { |n| backtrace(n) }) +
+          DEFAULT_COMPARE_DEPTH_ADDITION
+      end
+
+      notices.group_by do |notice|
+        backtrace(notice)[0..compare_depth]
+      end
+    end
+
+    def backtrace(notice)
+      return if notice.backtrace.is_a?(String)
+      notice.backtrace.first[1]
+    end
+
+    def average_first_project_line(backtraces)
+      depths = backtraces.map do |backtrace|
+        backtrace.index { |line| custom_file?(line) }
+      end.compact
+      return 0 if depths.size == 0
+      depths.inject(:+) / depths.size
+    end
+
+    def custom_file?(line)
+      line.start_with?("[PROJECT_ROOT]") && !line.start_with?("[PROJECT_ROOT]/vendor/")
+    end
+
     def add_notices_to_pages(errors)
       Parallel.map(errors, :in_threads => 10) do |error|
         begin
@@ -151,7 +202,7 @@ module AirbrakeTools
 
             Options:
         BANNER
-        opts.on("-c NUM", "--compare-depth NUM", Integer, "How deep to compare backtraces in summary (default: #{DEFAULT_COMPARE_DEPTH})") {|s| options[:compare_depth] = s }
+        opts.on("-c NUM", "--compare-depth NUM", Integer, "How deep to compare backtraces in summary (default: first line in project + #{DEFAULT_COMPARE_DEPTH_ADDITION})") {|s| options[:compare_depth] = s }
         opts.on("-p NUM", "--pages NUM", Integer, "How maybe pages to iterate over (default: hot:#{DEFAULT_HOT_PAGES} new:#{DEFAULT_NEW_PAGES} summary:#{DEFAULT_SUMMARY_PAGES})") {|s| options[:pages] = s }
         opts.on("-e ENV", "--environment ENV", String, "Only show errors from this environment (default: #{DEFAULT_ENVIRONMENT})") {|s| options[:env] = s }
         opts.on("-h", "--help", "Show this.") { puts opts; exit }

data/spec/airbrake_tools_spec.rb

@@ -1,75 +1,144 @@
 require 'yaml'
+require 'stringio'
 require 'airbrake_tools'
 
 ROOT = File.expand_path('../../', __FILE__)
 
 describe "airbrake-tools" do
-  def run(command, options={})
-    result = `#{command} 2>&1`
-    message = (options[:fail] ? "SUCCESS BUT SHOULD FAIL" : "FAIL")
-    raise "[#{message}] #{result} [#{command}]" if $?.success? == !!options[:fail]
-    result
-  end
+  before { Dir.chdir ROOT }
 
-  def airbrake_tools(args, options={})
-    run "#{ROOT}/bin/airbrake-tools #{args}", options
-  end
+  describe "CLI" do
+    def run(command, options={})
+      result = `#{command} 2>&1`
+      message = (options[:fail] ? "SUCCESS BUT SHOULD FAIL" : "FAIL")
+      raise "[#{message}] #{result} [#{command}]" if $?.success? == !!options[:fail]
+      result
+    end
 
-  let(:config) { YAML.load(File.read("spec/fixtures.yml")) }
+    def airbrake_tools(args, options={})
+      run "#{ROOT}/bin/airbrake-tools #{args}", options
+    end
 
-  before do
-    Dir.chdir ROOT
-  end
+    let(:config) { YAML.load(File.read("spec/fixtures.yml")) }
+
+    describe "basics" do
+      it "shows its usage without arguments" do
+        airbrake_tools("", :fail => true).should include("Usage")
+      end
+
+      it "shows its usage with -h" do
+        airbrake_tools("-h").should include("Usage")
+      end
 
-  describe "basics" do
-    it "shows its usage without arguments" do
-      airbrake_tools("", :fail => true).should include("Usage")
+      it "shows its usage with --help" do
+        airbrake_tools("--help").should include("Usage")
+      end
+
+      it "shows its version with -v" do
+        airbrake_tools("-v").should =~ /^airbrake-tools \d+\.\d+\.\d+$/
+      end
+
+      it "shows its version with --version" do
+        airbrake_tools("-v").should =~ /^airbrake-tools \d+\.\d+\.\d+$/
+      end
     end
 
-    it "shows its usage with -h" do
-      airbrake_tools("-h").should include("Usage")
+    describe "hot" do
+      it "kinda works" do
+        output = airbrake_tools("#{config["subdomain"]} #{config["auth_token"]} hot")
+        output.should =~ /#\d+\s+\d+\.\d+\/hour\s+total:\d+/
+      end
     end
 
-    it "shows its usage with --help" do
-      airbrake_tools("--help").should include("Usage")
+    describe "list" do
+      it "kinda works" do
+        output = airbrake_tools("#{config["subdomain"]} #{config["auth_token"]} list")
+        output.should include("Page 1 ")
+        output.should =~ /^\d+/
+      end
     end
 
-    it "shows its version with -v" do
-      airbrake_tools("-v").should =~ /^airbrake-tools \d+\.\d+\.\d+$/
+    describe "summary" do
+      it "kinda works" do
+        output = airbrake_tools("#{config["subdomain"]} #{config["auth_token"]} summary 51344729")
+        output.should include("last retrieved notice: ")
+        output.should include("last 2 hours: ")
+      end
     end
 
-    it "shows its version with --version" do
-      airbrake_tools("-v").should =~ /^airbrake-tools \d+\.\d+\.\d+$/
+    describe "new" do
+      it "kinda works" do
+        output = airbrake_tools("#{config["subdomain"]} #{config["auth_token"]} new")
+        output.should =~ /#\d+\s+\d+\.\d+\/hour\s+total:\d+/
+      end
     end
   end
 
-  describe "hot" do
-    it "kinda works" do
-      output = airbrake_tools("#{config["subdomain"]} #{config["auth_token"]} hot")
-      output.should =~ /#\d+\s+\d+\.\d+\/hour\s+total:\d+/
+  describe ".average_first_project_line" do
+    it "is 0 for 0" do
+      AirbrakeTools.send(:average_first_project_line, []).should == 0
     end
-  end
 
-  describe "list" do
-    it "kinda works" do
-      output = airbrake_tools("#{config["subdomain"]} #{config["auth_token"]} list")
-      output.should include("Page 1 ")
-      output.should =~ /^\d+/
+    it "is 0 for no matching line" do
+      AirbrakeTools.send(:average_first_project_line, [["/usr/local/rvm/rubies/foo.rb"]]).should == 0
+    end
+
+    it "is the average of matching lines" do
+      gem = "/usr/local/rvm/foo.rb:123"
+      local = "[PROJECT_ROOT]/foo.rb:123"
+      AirbrakeTools.send(:average_first_project_line, [
+        [gem, local, local, local], # 1
+        [gem, gem, gem, local, gem], # 3
+        [gem, gem, gem, gem, gem, gem], # 0
+      ]).should == 2
     end
   end
 
-  describe "summary" do
-    it "kinda works" do
-      output = airbrake_tools("#{config["subdomain"]} #{config["auth_token"]} summary 51344729")
-      output.should include("last retrieved notice: ")
-      output.should include("last 2 hours: ")
+  describe ".custom_file?" do
+    it "is custom if it's not a library" do
+      AirbrakeTools.send(:custom_file?, "[PROJECT_ROOT]/app/foo.rb:123").should == true
+    end
+
+    it "is not custom if it's a system gem" do
+      AirbrakeTools.send(:custom_file?, "/usr/local/rvm/foo.rb:123").should == false
+    end
+
+    it "is not custom if it's a vendored gem" do
+      AirbrakeTools.send(:custom_file?, "[PROJECT_ROOT]/vendor/bundle/xxx.rb:123").should == false
     end
   end
 
-  describe "newest" do
-    it "kinda works" do
-      output = airbrake_tools("#{config["subdomain"]} #{config["auth_token"]} new")
-      output.should =~ /#\d+\s+\d+\.\d+\/hour\s+total:\d+/
+  describe ".present_line" do
+    before do
+      $stdout.stub(:tty?).and_return false
+    end
+
+    it "does not add colors" do
+      AirbrakeTools.send(:present_line, "[PROJECT_ROOT]/vendor/bundle/foo.rb:123").should_not include("\e[")
+      AirbrakeTools.send(:present_line, "[PROJECT_ROOT]/app/foo.rb:123").should_not include("\e[")
+    end
+
+    context "on tty" do
+      before do
+        $stdout.stub(:tty?).and_return true
+      end
+
+      it "shows gray for vendor lines" do
+        AirbrakeTools.send(:present_line, "[PROJECT_ROOT]/vendor/bundle/foo.rb:123").should include("\e[")
+      end
+
+      it "does not add colors for project lines" do
+        AirbrakeTools.send(:present_line, "[PROJECT_ROOT]/app/foo.rb:123").should_not include("\e[")
+      end
+    end
+
+    it "adds blame if file exists" do
+      AirbrakeTools.send(:present_line, "[PROJECT_ROOT]/Gemfile:1 adasdsad").should ==
+        "Gemfile:1 adasdsad -- ^acc8204 (<jcheatham@zendesk.com> 2012-11-06 18:45:10 -0800 )"
+    end
+
+    it "does not add blame to system files" do
+      AirbrakeTools.send(:present_line, "/etc/hosts:1 adasdsad").should == "/etc/hosts:1 adasdsad"
     end
   end
 
@@ -125,4 +194,3 @@ describe "airbrake-tools" do
     end
   end
 end
-

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: airbrake_tools
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.10
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-13 00:00:00.000000000 Z
+date: 2013-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: airbrake-api
@@ -60,12 +60,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -3539053511181789551
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -3539053511181789551
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23