Find similar errors based on a digest fingerprint of the backtrace

Jared Pace
1 parent 795b9de3
Showing 7 changed files with 47 additions and 17 deletions Show diff stats
app/models/err.rb
app/models/notice.rb
app/views/projects/index.html.haml
lib/hoptoad.rb
spec/factories/err_factories.rb
spec/models/err_spec.rb
spec/models/notice_spec.rb
@@ -3,10 +3,10 @@ class Err
   include Mongoid::Timestamps
  
   field :klass
-  field :message
   field :component
   field :action
   field :environment
+  field :fingerprint
   field :resolved, :type => Boolean, :default => false
  
   referenced_in :project
@@ -40,4 +40,8 @@ class Err
     where
   end
  
+  def message
+    notices.first.message || klass
+  end
+  
 end
 \ No newline at end of file
@@ -4,6 +4,7 @@ class Notice
   include Mongoid::Document
   include Mongoid::Timestamps
  
+  field :message
   field :backtrace, :type => Array
   field :server_environment, :type => Hash
   field :request, :type => Hash
@@ -23,19 +24,20 @@ class Notice
     hoptoad_notice['request']['action']     = nil if hoptoad_notice['request']['action'].blank?
  
     error = Err.for({
-      :project    => project,
-      :klass      => hoptoad_notice['error']['class'],
-      :message    => hoptoad_notice['error']['message'],
-      :component  => hoptoad_notice['request']['component'],
-      :action     => hoptoad_notice['request']['action'],
-      :environment  => hoptoad_notice['server-environment']['environment-name']
+      :project      => project,
+      :klass        => hoptoad_notice['error']['class'],
+      :component    => hoptoad_notice['request']['component'],
+      :action       => hoptoad_notice['request']['action'],
+      :environment  => hoptoad_notice['server-environment']['environment-name'],
+      :fingerprint  => hoptoad_notice['fingerprint']
     })
  
     error.notices.create!({
-      :backtrace => hoptoad_notice['error']['backtrace']['line'],
+      :message            => hoptoad_notice['error']['message'],
+      :backtrace          => hoptoad_notice['error']['backtrace']['line'],
       :server_environment => hoptoad_notice['server-environment'],
-      :request => hoptoad_notice['request'],
-      :notifier => hoptoad_notice['notifier']
+      :request            => hoptoad_notice['request'],
+      :notifier           => hoptoad_notice['notifier']
     })
   end
  
@@ -12,4 +12,10 @@
       %tr
         %td.name= link_to project.name, project_path(project)
         %td.deploy= project.last_deploy_at ? project.last_deploy_at.to_s(:micro) : 'n/a'
-        %td.count= link_to project.errs.unresolved.count, project_errs_path(project)
 \ No newline at end of file
+        %td.count= link_to project.errs.unresolved.count, project_errs_path(project)
+    - if @projects.none?
+      %tr
+        %td{:colspan => 3}
+          %em
+            No projects here.
+            = link_to 'Click here to create your first one', new_project_path
 \ No newline at end of file
 module Hoptoad
   module V2
+    require 'digest/md5'
+    
     class ApiVersionError < StandardError
       def initialize
         super "Wrong API Version: Expecting v2.0"
@@ -9,7 +11,9 @@ module Hoptoad
     def self.parse_xml(xml)
       parsed  = ActiveSupport::XmlMini.backend.parse(xml)['notice']
       raise ApiVersionError unless parsed && parsed['version'] == '2.0'
-      rekey(parsed)
+      rekeyed = rekey(parsed)
+      rekeyed['fingerprint'] = Digest::MD5.hexdigest(rekeyed['error']['backtrace'].to_s)
+      rekeyed
     end
  
     private
 Factory.define :err do |e|
   e.project       {|p| p.association :project}
   e.klass         'FooError'
-  e.message       'FooError: Too Much Bar'
   e.component     'foo'
   e.action        'bar'
   e.environment   'production'
 end
  
 Factory.define :notice do |n|
-  n.err       {|e| e.association :err}
+  n.err                 {|e| e.association :err}
+  n.message             'FooError: Too Much Bar'
   n.backtrace           { random_backtrace }
   n.server_environment  'server-environment' => 'production'
   n.notifier            'name' => 'Notifier', 'version' => '1', 'url' => 'http://toad.com'
@@ -22,7 +22,6 @@ describe Err do
       @conditions = {
         :project      => @project,
         :klass        => 'Whoops',
-        :message      => 'Whoops: Oopsy Daisy',
         :component    => 'Foo',
         :action       => 'bar',
         :environment  => 'production'
@@ -59,6 +58,15 @@ describe Err do
     end
   end
  
+  context '#message' do
+    it 'returns the message from the first notice' do
+      err = Factory(:err)
+      notice1 = Factory(:notice, :err => err, :message => 'ERR 1')
+      notice2 = Factory(:notice, :err => err, :message => 'ERR 2')
+      err.message.should == notice1.message
+    end
+  end
+  
   context "#resolved?" do
     it "should start out as unresolved" do
       error = Err.new
@@ -26,6 +26,7 @@ describe Notice do
     before do
       @xml = Rails.root.join('spec','fixtures','hoptoad_test_notice.xml').read
       @project = Factory(:project, :api_key => 'ALLGLORYTOTHEHYPNOTOAD')
+      Digest::MD5.stub(:hexdigest).and_return('fingerprintdigest')
     end
  
     it 'finds the correct project' do
@@ -37,10 +38,10 @@ describe Notice do
       Err.should_receive(:for).with({
         :project      => @project,
         :klass        => 'HoptoadTestingException',
-        :message      => 'HoptoadTestingException: Testing hoptoad via "rake hoptoad:test". If you can see this, it works.',
         :component    => 'application',
         :action       => 'verify',
-        :environment  => 'development'
+        :environment  => 'development',
+        :fingerprint  => 'fingerprintdigest'
       }).and_return(err = Err.new)
       err.notices.stub(:create!)
       @notice = Notice.from_xml(@xml)
@@ -56,6 +57,11 @@ describe Notice do
       @notice.err.should be_a(Err)
     end
  
+    it 'captures the error message' do
+      @notice = Notice.from_xml(@xml)
+      @notice.message.should == 'HoptoadTestingException: Testing hoptoad via "rake hoptoad:test". If you can see this, it works.'
+    end
+    
     it 'captures the backtrace' do
       @notice = Notice.from_xml(@xml)
       @notice.backtrace.size.should == 73
...	...	@@ -3,10 +3,10 @@ class Err
3	3	include Mongoid::Timestamps
4	4
5	5	field :klass
6		- field :message
7	6	field :component
8	7	field :action
9	8	field :environment
	9	+ field :fingerprint
10	10	field :resolved, :type => Boolean, :default => false
11	11
12	12	referenced_in :project
...	...	@@ -40,4 +40,8 @@ class Err
40	40	where
41	41	end
42	42
	43	+ def message
	44	+ notices.first.message \|\| klass
	45	+ end
	46	+
43	47	end
44	48	\ No newline at end of file
...	...
...	...	@@ -4,6 +4,7 @@ class Notice
4	4	include Mongoid::Document
5	5	include Mongoid::Timestamps
6	6
	7	+ field :message
7	8	field :backtrace, :type => Array
8	9	field :server_environment, :type => Hash
9	10	field :request, :type => Hash
...	...	@@ -23,19 +24,20 @@ class Notice
23	24	hoptoad_notice['request']['action'] = nil if hoptoad_notice['request']['action'].blank?
24	25
25	26	error = Err.for({
26		- :project => project,
27		- :klass => hoptoad_notice['error']['class'],
28		- :message => hoptoad_notice['error']['message'],
29		- :component => hoptoad_notice['request']['component'],
30		- :action => hoptoad_notice['request']['action'],
31		- :environment => hoptoad_notice['server-environment']['environment-name']
	27	+ :project => project,
	28	+ :klass => hoptoad_notice['error']['class'],
	29	+ :component => hoptoad_notice['request']['component'],
	30	+ :action => hoptoad_notice['request']['action'],
	31	+ :environment => hoptoad_notice['server-environment']['environment-name'],
	32	+ :fingerprint => hoptoad_notice['fingerprint']
32	33	})
33	34
34	35	error.notices.create!({
35		- :backtrace => hoptoad_notice['error']['backtrace']['line'],
	36	+ :message => hoptoad_notice['error']['message'],
	37	+ :backtrace => hoptoad_notice['error']['backtrace']['line'],
36	38	:server_environment => hoptoad_notice['server-environment'],
37		- :request => hoptoad_notice['request'],
38		- :notifier => hoptoad_notice['notifier']
	39	+ :request => hoptoad_notice['request'],
	40	+ :notifier => hoptoad_notice['notifier']
39	41	})
40	42	end
41	43
...	...
...	...	@@ -12,4 +12,10 @@
12	12	%tr
13	13	%td.name= link_to project.name, project_path(project)
14	14	%td.deploy= project.last_deploy_at ? project.last_deploy_at.to_s(:micro) : 'n/a'
15		- %td.count= link_to project.errs.unresolved.count, project_errs_path(project)
16	15	\ No newline at end of file
	16	+ %td.count= link_to project.errs.unresolved.count, project_errs_path(project)
	17	+ - if @projects.none?
	18	+ %tr
	19	+ %td{:colspan => 3}
	20	+ %em
	21	+ No projects here.
	22	+ = link_to 'Click here to create your first one', new_project_path
17	23	\ No newline at end of file
...	...
1	1	module Hoptoad
2	2	module V2
	3	+ require 'digest/md5'
	4	+
3	5	class ApiVersionError < StandardError
4	6	def initialize
5	7	super "Wrong API Version: Expecting v2.0"
...	...	@@ -9,7 +11,9 @@ module Hoptoad
9	11	def self.parse_xml(xml)
10	12	parsed = ActiveSupport::XmlMini.backend.parse(xml)['notice']
11	13	raise ApiVersionError unless parsed && parsed['version'] == '2.0'
12		- rekey(parsed)
	14	+ rekeyed = rekey(parsed)
	15	+ rekeyed['fingerprint'] = Digest::MD5.hexdigest(rekeyed['error']['backtrace'].to_s)
	16	+ rekeyed
13	17	end
14	18
15	19	private
...	...
1	1	Factory.define :err do \|e\|
2	2	e.project {\|p\| p.association :project}
3	3	e.klass 'FooError'
4		- e.message 'FooError: Too Much Bar'
5	4	e.component 'foo'
6	5	e.action 'bar'
7	6	e.environment 'production'
8	7	end
9	8
10	9	Factory.define :notice do \|n\|
11		- n.err {\|e\| e.association :err}
	10	+ n.err {\|e\| e.association :err}
	11	+ n.message 'FooError: Too Much Bar'
12	12	n.backtrace { random_backtrace }
13	13	n.server_environment 'server-environment' => 'production'
14	14	n.notifier 'name' => 'Notifier', 'version' => '1', 'url' => 'http://toad.com'
...	...
...	...	@@ -22,7 +22,6 @@ describe Err do
22	22	@conditions = {
23	23	:project => @project,
24	24	:klass => 'Whoops',
25		- :message => 'Whoops: Oopsy Daisy',
26	25	:component => 'Foo',
27	26	:action => 'bar',
28	27	:environment => 'production'
...	...	@@ -59,6 +58,15 @@ describe Err do
59	58	end
60	59	end
61	60
	61	+ context '#message' do
	62	+ it 'returns the message from the first notice' do
	63	+ err = Factory(:err)
	64	+ notice1 = Factory(:notice, :err => err, :message => 'ERR 1')
	65	+ notice2 = Factory(:notice, :err => err, :message => 'ERR 2')
	66	+ err.message.should == notice1.message
	67	+ end
	68	+ end
	69	+
62	70	context "#resolved?" do
63	71	it "should start out as unresolved" do
64	72	error = Err.new
...	...
...	...	@@ -26,6 +26,7 @@ describe Notice do
26	26	before do
27	27	@xml = Rails.root.join('spec','fixtures','hoptoad_test_notice.xml').read
28	28	@project = Factory(:project, :api_key => 'ALLGLORYTOTHEHYPNOTOAD')
	29	+ Digest::MD5.stub(:hexdigest).and_return('fingerprintdigest')
29	30	end
30	31
31	32	it 'finds the correct project' do
...	...	@@ -37,10 +38,10 @@ describe Notice do
37	38	Err.should_receive(:for).with({
38	39	:project => @project,
39	40	:klass => 'HoptoadTestingException',
40		- :message => 'HoptoadTestingException: Testing hoptoad via "rake hoptoad:test". If you can see this, it works.',
41	41	:component => 'application',
42	42	:action => 'verify',
43		- :environment => 'development'
	43	+ :environment => 'development',
	44	+ :fingerprint => 'fingerprintdigest'
44	45	}).and_return(err = Err.new)
45	46	err.notices.stub(:create!)
46	47	@notice = Notice.from_xml(@xml)
...	...	@@ -56,6 +57,11 @@ describe Notice do
56	57	@notice.err.should be_a(Err)
57	58	end
58	59
	60	+ it 'captures the error message' do
	61	+ @notice = Notice.from_xml(@xml)
	62	+ @notice.message.should == 'HoptoadTestingException: Testing hoptoad via "rake hoptoad:test". If you can see this, it works.'
	63	+ end
	64	+
59	65	it 'captures the backtrace' do
60	66	@notice = Notice.from_xml(@xml)
61	67	@notice.backtrace.size.should == 73
...	...