Configure "email_at_notices" independently for each app. We have a combination o…

…f both low and high traffic sites, so this feature would be useful so that we can stay on top of errors in some cases, and avoid getting spammed in others.

Configure "email_at_notices" independently for each app. We have a combination o…
…f both low and high traffic sites, so this feature would be useful so that we can stay on top of errors in some cases, and avoid getting spammed in others.
Nathan Broadbent
1 parent 49468ce4
Showing 10 changed files with 103 additions and 26 deletions Show diff stats
app/controllers/apps_controller.rb
app/models/app.rb
app/models/notice.rb
app/views/apps/_fields.html.haml
config/config.example.yml
config/initializers/_load_config.rb
public/stylesheets/application.css
spec/controllers/apps_controller_spec.rb
spec/factories/app_factories.rb
spec/models/notice_spec.rb
@@ -2,6 +2,7 @@ class AppsController &lt; ApplicationController
   before_filter :require_admin!, :except => [:index, :show]
   before_filter :find_app, :except => [:index, :new, :create]
+  before_filter :parse_email_at_notices_or_set_default, :only => [:create, :update]
   def index
     @apps = current_user.admin? ? App.all : current_user.apps.all
@@ -73,4 +74,21 @@ class AppsController &lt; ApplicationController
       # apparently finding by 'watchers.email' and 'id' is broken
       raise(Mongoid::Errors::DocumentNotFound.new(App,@app.id)) unless current_user.admin? || current_user.watching?(@app)
     end
+
+    # email_at_notices is edited as a string, and stored as an array.
+    def parse_email_at_notices_or_set_default
+      if params[:app] && val = params[:app][:email_at_notices]
+        # Sanitize negative values, split on comma,
+        # strip, parse as integer, remove all '0's.
+        # If empty, set as default and show an error message.
+        email_at_notices = val.gsub(/-\d+/,"").split(",").map{|v| v.strip.to_i }.reject{|v| v == 0}
+        if email_at_notices.any?
+          params[:app][:email_at_notices] = email_at_notices
+        else
+          default_array = params[:app][:email_at_notices] = Errbit::Config.default_email_at_notices
+          flash[:error] = "Couldn't parse your notification frequency. Value was reset to default (#{default_array.join(', ')})."
+        end
+      end
+    end
 end
+
@@ -8,6 +8,7 @@ class App
   field :resolve_errs_on_deploy, :type => Boolean, :default => false
   field :notify_on_errs, :type => Boolean, :default => true
   field :notify_on_deploys, :type => Boolean, :default => true
+  field :email_at_notices, :type => Array, :default => Errbit::Config.default_email_at_notices
   # Some legacy apps may have sting as key instead of BSON::ObjectID
   identity :type => String
@@ -68,7 +69,7 @@ class App
   def github_url_to_file(file)
     "#{self.github_url}/blob/master#{file}"
   end
- 
+
   def issue_tracker_configured?
     issue_tracker && !issue_tracker.project_id.blank?
   end
@@ -96,3 +97,4 @@ class App
     end
 end
+
@@ -55,11 +55,11 @@ class Notice
     agent_string = env_vars['HTTP_USER_AGENT']
     agent_string.blank? ? nil : UserAgent.parse(agent_string)
   end
-  
+
   def self.in_app_backtrace_line? line
     !!(line['file'] =~ %r{^\[PROJECT_ROOT\]/(?!(vendor))})
   end
-  
+
   def request
     read_attribute(:request) || {}
   end
@@ -83,11 +83,11 @@ class Notice
   def cache_last_notice_at
     err.update_attributes(:last_notice_at => created_at)
   end
-  
+
   protected
   def should_notify?
-    err.app.notify_on_errs? && Errbit::Config.email_at_notices.include?(err.notices.count) && err.app.watchers.any?
+    err.app.notify_on_errs? && err.app.email_at_notices.include?(err.notices.count) && err.app.watchers.any?
   end
@@ -122,3 +122,4 @@ class Notice
     end
   end
 end
+
@@ -4,21 +4,34 @@
   = f.label :name
   = f.text_field :name
-%div.checkbox
-  = f.check_box :notify_on_errs
-  = f.label :notify_on_errs, 'Notify on errors'
-
 %div
   = f.label :github_url
   = f.text_field :github_url
+%fieldset
+  %legend Notifications
+  %div.checkbox
+    = f.check_box :notify_on_errs
+    = f.label :notify_on_errs, 'Notify on errors'
+  %div.email_at_notices_nested{:style => f.object.notify_on_errs ? '' : 'display: none;'}
+    .field-helpertext Send a notification every
+    -# Edit the email_at_notices array as a CSV string
+    = f.text_field :email_at_notices, :value => f.object.email_at_notices.join(", ")
+    .field-helpertext times an error occurs. (CSV)
+  %div.checkbox
+    = f.check_box :notify_on_deploys
+    = f.label :notify_on_deploys, 'Notify on deploys'
+
+:javascript
+  $('#app_notify_on_errs').change(function(){
+    var el = $('.email_at_notices_nested');
+    this.checked ? el.show() : el.hide();
+  });
+
 %div.checkbox
   = f.check_box :resolve_errs_on_deploy
   = f.label :resolve_errs_on_deploy, 'Resolve errs on deploy'
-%div.checkbox
-  = f.check_box :notify_on_deploys
-  = f.label :notify_on_deploys, 'Notify on deploys'
 %fieldset.nested-wrapper
   %legend Watchers
@@ -75,3 +88,4 @@
         = w.text_field :username, :placeholder => 'Username/Email for your account'
         = w.label :password, 'account password'
         = w.password_field :password, :placeholder => 'Password for your account'
+
@@ -14,11 +14,13 @@ host: errbit.example.com
 # will be sent from.
 email_from: errbit@example.com
-# Configure when emails are sent for an error.
+# Configure the default value for when emails are sent for an error.
 # [1,3,7] = 1st, 3rd, and 7th occurence triggers
 # an email notification.
-email_at_notices: [1, 10, 100]
+# Each app can be configured individually.
+default_email_at_notices: [1, 10, 100]
-# Set to false to suppress confirmation when 
+# Set to false to suppress confirmation when
 # resolving errors.
 confirm_resolve_err: true
+
@@ -4,7 +4,7 @@ if ENV[&#39;HEROKU&#39;]
   Errbit::Config = OpenStruct.new
   Errbit::Config.host = ENV['ERRBIT_HOST']
   Errbit::Config.email_from = ENV['ERRBIT_EMAIL_FROM']
-  Errbit::Config.email_at_notices = [1,3,10] #ENV['ERRBIT_EMAIL_AT_NOTICES']
+  Errbit::Config.default_email_at_notices = [1,3,10] #ENV['ERRBIT_EMAIL_AT_NOTICES']
   Errbit::Application.config.action_mailer.smtp_settings = {
     :address        => "smtp.sendgrid.net",
     :port           => "25",
@@ -25,4 +25,5 @@ end
 # Set config specific values
 (Errbit::Application.config.action_mailer.default_url_options ||= {}).tap do |default|
   default.merge! :host => Errbit::Config.host if default[:host].blank?
-end
 \ No newline at end of file
+end
+
@@ -350,6 +350,17 @@ form .error-messages ul {
   list-style-type: square;
 }
+form .field-helpertext {
+  display: inline;
+  text-transform: uppercase;
+}
+
+form input#app_email_at_notices {
+  width: 130px;
+  margin: 0 5px;
+}
+
+
 /* Tables */
 table {
   width: 100%;
@@ -683,3 +694,4 @@ span.click_span {
 #deploys_div, #repository_div, #watchers_div {
   display: none;
 }
+
@@ -241,6 +241,27 @@ describe AppsController do
         end
       end
+      context "changing email_at_notices" do
+        it "should parse legal csv values" do
+          put :update, :id => @app.id, :app => { :email_at_notices => '1,   4,      7,8,  10' }
+          @app.reload
+          @app.email_at_notices.should == [1, 4, 7, 8, 10]
+        end
+        context "failed parsing of CSV" do
+          it "should set the default value" do
+            @app = Factory(:app, :email_at_notices => [1, 2, 3, 4])
+            put :update, :id => @app.id, :app => { :email_at_notices => 'asdf, -1,0,foobar,gd00,0,abc' }
+            @app.reload
+            @app.email_at_notices.should == Errbit::Config.default_email_at_notices
+          end
+
+          it "should display a message" do
+            put :update, :id => @app.id, :app => { :email_at_notices => 'qwertyuiop' }
+            request.flash[:error].should match(/Couldn't parse/)
+          end
+        end
+      end
+
       context "setting up issue tracker", :cur => true do
         context "unknown tracker type" do
           before(:each) do
@@ -386,3 +407,4 @@ describe AppsController do
   end
 end
+
 Factory.define(:app) do |p|
   p.name { Factory.next :app_name }
+  p.email_at_notices { [1, 10, 100] }
 end
 Factory.define(:app_with_watcher, :parent => :app) do |p|
@@ -26,3 +27,4 @@ Factory.define(:deploy) do |d|
   d.environment   'production'
   d.revision      ActiveSupport::SecureRandom.hex(10)
 end
+
@@ -21,15 +21,15 @@ describe Notice do
       notice.errors[:notifier].should include("can't be blank")
     end
   end
-  
+
   context '.in_app_backtrace_line?' do
     let(:backtrace) do [{
         'number'  => rand(999),
-        'file'    => '[GEM_ROOT]/gems/actionpack-3.0.4/lib/action_controller/metal/rescue.rb', 
+        'file'    => '[GEM_ROOT]/gems/actionpack-3.0.4/lib/action_controller/metal/rescue.rb',
         'method'  => ActiveSupport.methods.shuffle.first
       }, {
         'number'  => rand(999),
-        'file'    => '[PROJECT_ROOT]/vendor/plugins/seamless_database_pool/lib/seamless_database_pool/controller_filter.rb', 
+        'file'    => '[PROJECT_ROOT]/vendor/plugins/seamless_database_pool/lib/seamless_database_pool/controller_filter.rb',
         'method'  => ActiveSupport.methods.shuffle.first
       }, {
         'number'  => rand(999),
@@ -50,7 +50,7 @@ describe Notice do
       Notice.in_app_backtrace_line?(backtrace[2]).should == true
     end
   end
-  
+
   context '#from_xml' do
     before do
       @xml = Rails.root.join('spec','fixtures','hoptoad_test_notice.xml').read
@@ -154,20 +154,22 @@ describe Notice do
       notice.user_agent.browser.should == 'Chrome'
       notice.user_agent.version.to_s.should =~ /^10\.0/
     end
-    
+
     it "should be nil if HTTP_USER_AGENT is blank" do
       notice = Factory.build(:notice)
       notice.user_agent.should == nil
     end
   end
-  
-  describe "email notifications" do
+
+  describe "email notifications (configured individually for each app)" do
+    custom_thresholds = [2, 4, 8, 16, 32, 64]
+
     before do
-      @app = Factory(:app_with_watcher)
+      @app = Factory(:app_with_watcher, :email_at_notices => custom_thresholds)
       @err = Factory(:err, :app => @app)
     end
-    Errbit::Config.email_at_notices.each do |threshold|
+    custom_thresholds.each do |threshold|
       it "sends an email notification after #{threshold} notice(s)" do
         @err.notices.stub(:count).and_return(threshold)
         Mailer.should_receive(:err_notification).
@@ -178,3 +180,4 @@ describe Notice do
   end
 end
+
	@@ -2,6 +2,7 @@ class AppsController < ApplicationController		@@ -2,6 +2,7 @@ class AppsController < ApplicationController
2		2
3	before_filter :require_admin!, :except => [:index, :show]	3	before_filter :require_admin!, :except => [:index, :show]
4	before_filter :find_app, :except => [:index, :new, :create]	4	before_filter :find_app, :except => [:index, :new, :create]
		5	+ before_filter :parse_email_at_notices_or_set_default, :only => [:create, :update]
5		6
6	def index	7	def index
7	@apps = current_user.admin? ? App.all : current_user.apps.all	8	@apps = current_user.admin? ? App.all : current_user.apps.all
	@@ -73,4 +74,21 @@ class AppsController < ApplicationController		@@ -73,4 +74,21 @@ class AppsController < ApplicationController
73	# apparently finding by 'watchers.email' and 'id' is broken	74	# apparently finding by 'watchers.email' and 'id' is broken
74	raise(Mongoid::Errors::DocumentNotFound.new(App,@app.id)) unless current_user.admin? \|\| current_user.watching?(@app)	75	raise(Mongoid::Errors::DocumentNotFound.new(App,@app.id)) unless current_user.admin? \|\| current_user.watching?(@app)
75	end	76	end
		77	+
		78	+ # email_at_notices is edited as a string, and stored as an array.
		79	+ def parse_email_at_notices_or_set_default
		80	+ if params[:app] && val = params[:app][:email_at_notices]
		81	+ # Sanitize negative values, split on comma,
		82	+ # strip, parse as integer, remove all '0's.
		83	+ # If empty, set as default and show an error message.
		84	+ email_at_notices = val.gsub(/-\d+/,"").split(",").map{\|v\| v.strip.to_i }.reject{\|v\| v == 0}
		85	+ if email_at_notices.any?
		86	+ params[:app][:email_at_notices] = email_at_notices
		87	+ else
		88	+ default_array = params[:app][:email_at_notices] = Errbit::Config.default_email_at_notices
		89	+ flash[:error] = "Couldn't parse your notification frequency. Value was reset to default (#{default_array.join(', ')})."
		90	+ end
		91	+ end
		92	+ end
76	end	93	end
		94	+
	@@ -4,7 +4,7 @@ if ENV['HEROKU']		@@ -4,7 +4,7 @@ if ENV['HEROKU']
4	Errbit::Config = OpenStruct.new	4	Errbit::Config = OpenStruct.new
5	Errbit::Config.host = ENV['ERRBIT_HOST']	5	Errbit::Config.host = ENV['ERRBIT_HOST']
6	Errbit::Config.email_from = ENV['ERRBIT_EMAIL_FROM']	6	Errbit::Config.email_from = ENV['ERRBIT_EMAIL_FROM']
7	- Errbit::Config.email_at_notices = [1,3,10] #ENV['ERRBIT_EMAIL_AT_NOTICES']	7	+ Errbit::Config.default_email_at_notices = [1,3,10] #ENV['ERRBIT_EMAIL_AT_NOTICES']
8	Errbit::Application.config.action_mailer.smtp_settings = {	8	Errbit::Application.config.action_mailer.smtp_settings = {
9	:address => "smtp.sendgrid.net",	9	:address => "smtp.sendgrid.net",
10	:port => "25",	10	:port => "25",
	@@ -25,4 +25,5 @@ end		@@ -25,4 +25,5 @@ end
25	# Set config specific values	25	# Set config specific values
26	(Errbit::Application.config.action_mailer.default_url_options \|\|= {}).tap do \|default\|	26	(Errbit::Application.config.action_mailer.default_url_options \|\|= {}).tap do \|default\|
27	default.merge! :host => Errbit::Config.host if default[:host].blank?	27	default.merge! :host => Errbit::Config.host if default[:host].blank?
28	-end
29	\ No newline at end of file	28	\ No newline at end of file
		29	+end
		30	+
	@@ -350,6 +350,17 @@ form .error-messages ul {		@@ -350,6 +350,17 @@ form .error-messages ul {
350	list-style-type: square;	350	list-style-type: square;
351	}	351	}
352		352
		353	+form .field-helpertext {
		354	+ display: inline;
		355	+ text-transform: uppercase;
		356	+}
		357	+
		358	+form input#app_email_at_notices {
		359	+ width: 130px;
		360	+ margin: 0 5px;
		361	+}
		362	+
		363	+
353	/* Tables */	364	/* Tables */
354	table {	365	table {
355	width: 100%;	366	width: 100%;
	@@ -683,3 +694,4 @@ span.click_span {		@@ -683,3 +694,4 @@ span.click_span {
683	#deploys_div, #repository_div, #watchers_div {	694	#deploys_div, #repository_div, #watchers_div {
684	display: none;	695	display: none;
685	}	696	}
		697	+
	@@ -241,6 +241,27 @@ describe AppsController do		@@ -241,6 +241,27 @@ describe AppsController do
241	end	241	end
242	end	242	end
243		243
		244	+ context "changing email_at_notices" do
		245	+ it "should parse legal csv values" do
		246	+ put :update, :id => @app.id, :app => { :email_at_notices => '1, 4, 7,8, 10' }
		247	+ @app.reload
		248	+ @app.email_at_notices.should == [1, 4, 7, 8, 10]
		249	+ end
		250	+ context "failed parsing of CSV" do
		251	+ it "should set the default value" do
		252	+ @app = Factory(:app, :email_at_notices => [1, 2, 3, 4])
		253	+ put :update, :id => @app.id, :app => { :email_at_notices => 'asdf, -1,0,foobar,gd00,0,abc' }
		254	+ @app.reload
		255	+ @app.email_at_notices.should == Errbit::Config.default_email_at_notices
		256	+ end
		257	+
		258	+ it "should display a message" do
		259	+ put :update, :id => @app.id, :app => { :email_at_notices => 'qwertyuiop' }
		260	+ request.flash[:error].should match(/Couldn't parse/)
		261	+ end
		262	+ end
		263	+ end
		264	+
244	context "setting up issue tracker", :cur => true do	265	context "setting up issue tracker", :cur => true do
245	context "unknown tracker type" do	266	context "unknown tracker type" do
246	before(:each) do	267	before(:each) do
	@@ -386,3 +407,4 @@ describe AppsController do		@@ -386,3 +407,4 @@ describe AppsController do
386	end	407	end
387		408
388	end	409	end
		410	+