bugsnag 1.2.17 → 1.2.18

data/CHANGELOG.md

@@ -1,6 +1,10 @@
 Changelog
 =========
 
+1.2.18
+------
+-   Add support for bugsnag meta data in exceptions.
+
 1.2.17
 ------
 -   Clear the before bugsnag notify callbacks on sidekiq when a job is complete

data/README.md

@@ -3,12 +3,12 @@ Bugsnag Notifier for Ruby
 
 The Bugsnag Notifier for Ruby gives you instant notification of exceptions
 thrown from your **Rails**, **Sinatra**, **Rack** or **plain Ruby** app.
-Any uncaught exceptions will trigger a notification to be sent to your 
+Any uncaught exceptions will trigger a notification to be sent to your
 Bugsnag project.
 
-[Bugsnag](http://bugsnag.com) captures errors in real-time from your web, 
-mobile and desktop applications, helping you to understand and resolve them 
-as fast as possible. [Create a free account](http://bugsnag.com) to start 
+[Bugsnag](http://bugsnag.com) captures errors in real-time from your web,
+mobile and desktop applications, helping you to understand and resolve them
+as fast as possible. [Create a free account](http://bugsnag.com) to start
 capturing exceptions from your applications.
 
 
@@ -59,13 +59,13 @@ How to Install
 Sending Custom Data With Exceptions
 -----------------------------------
 
-It is often useful to send additional meta-data about your app, such as 
+It is often useful to send additional meta-data about your app, such as
 information about the currently logged in user, along with any
-exceptions, to help debug problems. 
+exceptions, to help debug problems.
 
 ### Rails Apps
 
-In any rails controller you can define a `before_bugsnag_notify` callback, 
+In any rails controller you can define a `before_bugsnag_notify` callback,
 which allows you to add this additional data by calling `add_tab` on the
 exception notification object.
 
@@ -89,7 +89,7 @@ end
 
 ### Other Ruby Apps
 
-In other ruby apps, you can provide lambda functions to execute before any 
+In other ruby apps, you can provide lambda functions to execute before any
 `Bugsnag.notify` calls as follows. Don't forget to clear the callbacks at the
 end of each request or session.
 
@@ -107,6 +107,26 @@ Bugsnag.before_notify_callbacks << lambda {|notif|
 Bugsnag.before_notify_callbacks.clear
 ```
 
+### Exceptions with Meta Data
+
+If you include the `Bugsnag::MetaData` module into your own exceptions, you can
+associate meta data with a paticular exception.
+
+```ruby
+class MyCustomException < Exception
+  include Bugsnag::MetaData
+end
+
+exception = MyCustomException.new("It broke!")
+exception.bugsnag_meta_data = {
+  :user_info => {
+    name: current_user.name
+  }
+}
+
+raise exception
+```
+
 You can read more about how callbacks work in the
 [Bugsnag Middleware](#bugsnag-middleware) documentation below.
 
@@ -162,18 +182,18 @@ you can set the `release_stage` that is reported to Bugsnag.
 ```ruby
 config.release_stage = "development"
 ```
-    
+
 In rails apps this value is automatically set from `RAILS_ENV`, and in rack
-apps it is automatically set to `RACK_ENV`. Otherwise the default is 
+apps it is automatically set to `RACK_ENV`. Otherwise the default is
 "production".
 
 ###notify_release_stages
 
-By default, we will only notify Bugsnag of exceptions that happen when 
-your `release_stage` is set to be "production". If you would like to 
+By default, we will only notify Bugsnag of exceptions that happen when
+your `release_stage` is set to be "production". If you would like to
 change which release stages notify Bugsnag of exceptions you can
 set `notify_release_stages`:
-    
+
 ```ruby
 config.notify_release_stages = ["production", "development"]
 ```
@@ -183,7 +203,7 @@ config.notify_release_stages = ["production", "development"]
 By default, we will automatically notify Bugsnag of any fatal exceptions
 in your application. If you want to stop this from happening, you can set
 `auto_notify`:
-    
+
 ```ruby
 config.auto_notify = false
 ```
@@ -210,7 +230,7 @@ config.project_root = "/var/www/myproject"
 
 ###app_version
 
-If you want to track which versions of your application each exception 
+If you want to track which versions of your application each exception
 happens in, you can set `app_version`. This is set to `nil` by default.
 
 ```ruby
@@ -220,8 +240,8 @@ config.app_version = "2.5.1"
 ###params_filters
 
 Sets the strings to filter out from the `params` hashes before sending
-them to Bugsnag. Use this if you want to ensure you don't send 
-sensitive data such as passwords, and credit card numbers to our 
+them to Bugsnag. Use this if you want to ensure you don't send
+sensitive data such as passwords, and credit card numbers to our
 servers. Any keys which contain these strings will be filtered.
 
 ```ruby
@@ -238,7 +258,7 @@ Sets for which exception classes we should not send exceptions to bugsnag.com.
 config.ignore_classes << "ActiveRecord::StatementInvalid"
 ```
 
-You can also provide a lambda function here to ignore by other exception 
+You can also provide a lambda function here to ignore by other exception
 attributes or by a regex:
 
 ```ruby
@@ -260,7 +280,7 @@ By default, `ignore_classes` contains the following:
 
 ###logger
 
-Sets which logger to use for Bugsnag log messages. In rails apps, this is 
+Sets which logger to use for Bugsnag log messages. In rails apps, this is
 automatically set to use `Rails.logger`, otherwise it will be set to
 `Logger.new(STDOUT)`.
 
@@ -273,12 +293,12 @@ Provides access to the middleware stack, see the
 Bugsnag Middleware
 ------------------
 
-The Bugsnag Notifier for Ruby provides its own middleware system, similar to 
-the one used in Rack applications. Middleware allows you to execute code 
-before and after an exception is sent to bugsnag.com, so you can do things 
+The Bugsnag Notifier for Ruby provides its own middleware system, similar to
+the one used in Rack applications. Middleware allows you to execute code
+before and after an exception is sent to bugsnag.com, so you can do things
 such as:
 
--   Send application-specific information along with exceptions, eg. the name 
+-   Send application-specific information along with exceptions, eg. the name
     of the currently logged in user,
 -   Write exception information to your internal logging system.
 
@@ -317,7 +337,7 @@ for some real examples of middleware in action.
 Deploy Tracking
 ---------------
 
-Bugsnag allows you to track deploys of your apps. By sending the 
+Bugsnag allows you to track deploys of your apps. By sending the
 source revision or application version to bugsnag.com when you deploy a new
 version of your app, you'll be able to see which deploy each error was
 introduced in.
@@ -341,8 +361,8 @@ your deploy scripts.
 rake bugsnag:deploy BUGSNAG_REVISION=source-control-revision BUGSNAG_RELEASE_STAGE=production
 ```
 
-The bugsnag rake tasks will be automatically available for Rails 3 
-apps, to make the rake tasks available in other apps, add the following to 
+The bugsnag rake tasks will be automatically available for Rails 3
+apps, to make the rake tasks available in other apps, add the following to
 your `Rakefile`:
 
 ```ruby
@@ -354,24 +374,24 @@ require "bugsnag/tasks"
 You can set the following environmental variables to override or specify
 additional deploy information:
 
--   **BUGSNAG_RELEASE_STAGE** - 
+-   **BUGSNAG_RELEASE_STAGE** -
     The release stage (eg, production, staging) currently being deployed.
     This is set automatically from your Bugsnag settings or rails/rack
     environment.
 
--   **BUGSNAG_API_KEY** - 
+-   **BUGSNAG_API_KEY** -
     Your Bugsnag API key. This is set automatically from your Bugsnag
     settings in your app.
-    
--   **BUGSNAG_REPOSITORY** - 
-    The repository from which you are deploying the code. This is set 
+
+-   **BUGSNAG_REPOSITORY** -
+    The repository from which you are deploying the code. This is set
     automatically if you are using capistrano.
 
--   **BUGSNAG_BRANCH** - 
+-   **BUGSNAG_BRANCH** -
     The source control branch from which you are deploying the code.
     This is set automatically if you are using capistrano.
 
--   **BUGSNAG_REVISION** - 
+-   **BUGSNAG_REVISION** -
     The source control revision for the code you are currently deploying.
     This is set automatically if you are using capistrano.
 
@@ -385,8 +405,8 @@ documentation.
 
 ### EventMachine Apps
 
-If your app uses [EventMachine](http://rubyeventmachine.com/) you'll need to 
-manually notify Bugsnag of errors. There are two ways to do this in your 
+If your app uses [EventMachine](http://rubyeventmachine.com/) you'll need to
+manually notify Bugsnag of errors. There are two ways to do this in your
 EventMachine apps, first you should implement `EventMachine.error_handler`:
 
 ```ruby
@@ -438,5 +458,5 @@ Build Status
 License
 -------
 
-The Bugsnag ruby notifier is free software released under the MIT License. 
-See [LICENSE.txt](https://github.com/bugsnag/bugsnag-ruby/blob/master/LICENSE.txt) for details.
+The Bugsnag ruby notifier is free software released under the MIT License.
+See [LICENSE.txt](https://github.com/bugsnag/bugsnag-ruby/blob/master/LICENSE.txt) for details.

data/VERSION

@@ -1 +1 @@
-1.2.17
+1.2.18

data/bugsnag.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{bugsnag}
-  s.version = "1.2.17"
+  s.version = "1.2.18"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["James Smith"]
@@ -33,6 +33,7 @@ Gem::Specification.new do |s|
     "lib/bugsnag/configuration.rb",
     "lib/bugsnag/delay/resque.rb",
     "lib/bugsnag/helpers.rb",
+    "lib/bugsnag/meta_data.rb",
     "lib/bugsnag/middleware/callbacks.rb",
     "lib/bugsnag/middleware/rack_request.rb",
     "lib/bugsnag/middleware/rails2_request.rb",

data/lib/bugsnag.rb

@@ -2,6 +2,7 @@ require "rubygems"
 
 require "bugsnag/version"
 require "bugsnag/configuration"
+require "bugsnag/meta_data"
 require "bugsnag/notification"
 require "bugsnag/helpers"
 
@@ -30,7 +31,7 @@ module Bugsnag
 
       # Log that we are ready to rock
       if configuration.api_key && !@logged_ready
-        log "Bugsnag exception handler #{VERSION} ready, api_key=#{configuration.api_key}" 
+        log "Bugsnag exception handler #{VERSION} ready, api_key=#{configuration.api_key}"
         @logged_ready = true
       end
     end
@@ -46,7 +47,7 @@ module Bugsnag
       notification.deliver unless notification.ignore?
     end
 
-    # Auto notify of an exception, called from rails and rack exception 
+    # Auto notify of an exception, called from rails and rack exception
     # rescuers, unless auto notification is disabled, or we should ignore this
     # error class
     def auto_notify(exception, overrides=nil, request_data=nil)
@@ -78,7 +79,7 @@ module Bugsnag
       Bugsnag.configuration.set_request_data(key, value)
     end
 
-    # Clear all "per-request" data, temporal data for use in bugsnag middleware    
+    # Clear all "per-request" data, temporal data for use in bugsnag middleware
     # This method should be called after each distinct request or session ends
     # Eg. After completing a page request in a web app
     def clear_request_data
@@ -95,4 +96,4 @@ module Bugsnag
       Bugsnag.configuration.request_data[:after_callbacks] ||= []
     end
   end
-end
+end

data/lib/bugsnag/meta_data.rb

@@ -0,0 +1,7 @@
+module Bugsnag
+  module MetaData
+    attr_accessor :bugsnag_meta_data
+    attr_accessor :bugsnag_user_id
+    attr_accessor :bugsnag_context
+  end
+end

data/lib/bugsnag/notification.rb

@@ -17,16 +17,16 @@ module Bugsnag
     # HTTParty settings
     headers  "Content-Type" => "application/json"
     default_timeout 5
-    
+
     attr_accessor :context
     attr_accessor :user_id
-    
+
     class << self
       def deliver_exception_payload(endpoint, payload)
         begin
           payload_string = Bugsnag::Helpers.dump_json(payload)
-        
-          # If the payload is going to be too long, we trim the hashes to send 
+
+          # If the payload is going to be too long, we trim the hashes to send
           # a minimal payload instead
           if payload_string.length > 128000
             payload[:events].each {|e| e[:metaData] = Bugsnag::Helpers.reduce_hash_size(e[:metaData])}
@@ -50,7 +50,7 @@ module Bugsnag
       @overrides = Bugsnag::Helpers.flatten_meta_data(overrides) || {}
       @request_data = request_data
       @meta_data = {}
-      
+
       # Unwrap exceptions
       @exceptions = []
       ex = exception
@@ -66,7 +66,7 @@ module Bugsnag
         end
       end
     end
-    
+
     # Add a single value as custom data, to this notification
     def add_custom_data(name, value)
       @meta_data[:custom] ||= {}
@@ -110,13 +110,24 @@ module Bugsnag
       Bugsnag.warn "You should set your app's release_stage (see https://bugsnag.com/docs/notifiers/ruby#release_stage)." unless @configuration.release_stage
 
       @meta_data = {}
-      
+
       # Run the middleware here, at the end of the middleware stack, execute the actual delivery
       @configuration.middleware.run(self) do
         # Now override the required fields
+        exceptions.each do |exception|
+          if exception.class.include?(Bugsnag::MetaData)
+            if exception.bugsnag_user_id.is_a?(String)
+              self.user_id = exception.bugsnag_user_id
+            end
+            if exception.bugsnag_context.is_a?(String)
+              self.context = exception.bugsnag_context
+            end
+          end
+        end
+
         [:user_id, :context].each do |symbol|
           if @overrides[symbol]
-            self.send("#{symbol}=", @overrides[symbol] )
+            self.send("#{symbol}=", @overrides[symbol])
             @overrides.delete symbol
           end
         end
@@ -132,7 +143,7 @@ module Bugsnag
           :context => self.context,
           :userId => self.user_id,
           :exceptions => exception_list,
-          :metaData => Bugsnag::Helpers.cleanup_obj(generate_meta_data(@overrides), @configuration.params_filters)
+          :metaData => Bugsnag::Helpers.cleanup_obj(generate_meta_data(@exceptions, @overrides), @configuration.params_filters)
         }.reject {|k,v| v.nil? }
 
         # Build the payload hash
@@ -160,39 +171,52 @@ module Bugsnag
     def request_data
       @request_data || Bugsnag.configuration.request_data
     end
-    
+
     def exceptions
       @exceptions
     end
 
     private
-    # Generate the meta data from both the request configuration and the overrides for this notification
-    def generate_meta_data(overrides)
+
+    # Generate the meta data from both the request configuration, the overrides and the exceptions for this notification
+    def generate_meta_data(exceptions, overrides)
       # Copy the request meta data so we dont edit it by mistake
       meta_data = @meta_data.dup
-      
-      overrides.each do |key, value|
-        # If its a hash, its a tab so we can just add it providing its not reserved
-        if value.is_a? Hash
-          key = key.to_sym
-          
-          if meta_data[key]
-            # If its a clash, merge with the existing data
-            meta_data[key].merge! value
-          else
-            # Add it as is if its not special
-            meta_data[key] = value
+
+      exceptions.each do |exception|
+        if exception.class.include?(Bugsnag::MetaData) && exception.bugsnag_meta_data
+          exception.bugsnag_meta_data.each do |key, value|
+            add_to_meta_data key, value, meta_data
           end
-        else
-          meta_data[:custom] ||= {}
-          meta_data[:custom][key] = value
         end
       end
-      
+
+      overrides.each do |key, value|
+        add_to_meta_data key, value, meta_data
+      end
+
       meta_data
     end
-    
-    def exception_list      
+
+    def add_to_meta_data(key, value, meta_data)
+      # If its a hash, its a tab so we can just add it providing its not reserved
+      if value.is_a? Hash
+        key = key.to_sym
+
+        if meta_data[key]
+          # If its a clash, merge with the existing data
+          meta_data[key].merge! value
+        else
+          # Add it as is if its not special
+          meta_data[key] = value
+        end
+      else
+        meta_data[:custom] ||= {}
+        meta_data[:custom][key] = value
+      end
+    end
+
+    def exception_list
       @exceptions.map do |exception|
         {
           :errorClass => error_class(exception),
@@ -201,15 +225,15 @@ module Bugsnag
         }
       end
     end
-    
+
     def error_class(exception)
-      # The "Class" check is for some strange exceptions like Timeout::Error 
+      # The "Class" check is for some strange exceptions like Timeout::Error
       # which throw the error class instead of an instance
       (exception.is_a? Class) ? exception.name : exception.class.name
     end
 
     def stacktrace(exception)
-      (exception.backtrace || caller).map do |trace|        
+      (exception.backtrace || caller).map do |trace|
         method = nil
         file, line_str, method_str = trace.split(":")
 
@@ -224,7 +248,7 @@ module Bugsnag
         trace_hash[:lineNumber] = line_str.to_i
 
         # Clean up the file path in the stacktrace
-        if defined?(Bugsnag.configuration.project_root) && Bugsnag.configuration.project_root.to_s != '' 
+        if defined?(Bugsnag.configuration.project_root) && Bugsnag.configuration.project_root.to_s != ''
           file.sub!(/#{Bugsnag.configuration.project_root}\//, "")
         end
 
@@ -250,4 +274,4 @@ module Bugsnag
       end.compact
     end
   end
-end
+end

data/spec/notification_spec.rb

@@ -3,6 +3,7 @@ require 'securerandom'
 
 module ActiveRecord; class RecordNotFound < RuntimeError; end; end
 class NestedException < StandardError; attr_accessor :original_exception; end
+class BugsnagTestExceptionWithMetaData < Exception; include Bugsnag::MetaData; end
 
 describe Bugsnag::Notification do
   it "should contain an api_key if one is set" do
@@ -86,6 +87,92 @@ describe Bugsnag::Notification do
     })
   end
 
+  it "should accept meta data from an exception that mixes in Bugsnag::MetaData" do
+    Bugsnag::Notification.should_receive(:deliver_exception_payload) do |endpoint, payload|
+      event = get_event_from_payload(payload)
+      event[:metaData][:some_tab].should_not be_nil
+      event[:metaData][:some_tab][:info].should be == "here"
+      event[:metaData][:some_tab][:data].should be == "also here"
+    end
+
+    exception = BugsnagTestExceptionWithMetaData.new("It crashed")
+    exception.bugsnag_meta_data = {
+      :some_tab => {
+        :info => "here",
+        :data => "also here"
+      }
+    }
+
+    Bugsnag.notify(exception)
+  end
+  
+  it "should accept meta data from an exception that mixes in Bugsnag::MetaData, but override using the overrides" do
+    Bugsnag::Notification.should_receive(:deliver_exception_payload) do |endpoint, payload|
+      event = get_event_from_payload(payload)
+      event[:metaData][:some_tab].should_not be_nil
+      event[:metaData][:some_tab][:info].should be == "overridden"
+      event[:metaData][:some_tab][:data].should be == "also here"
+    end
+
+    exception = BugsnagTestExceptionWithMetaData.new("It crashed")
+    exception.bugsnag_meta_data = {
+      :some_tab => {
+        :info => "here",
+        :data => "also here"
+      }
+    }
+
+    Bugsnag.notify(exception, {:some_tab => {:info => "overridden"}})
+  end
+  
+  it "should accept user_id from an exception that mixes in Bugsnag::MetaData" do
+    Bugsnag::Notification.should_receive(:deliver_exception_payload) do |endpoint, payload|
+      event = get_event_from_payload(payload)
+      event[:userId].should be == "exception_user_id"
+    end
+
+    exception = BugsnagTestExceptionWithMetaData.new("It crashed")
+    exception.bugsnag_user_id = "exception_user_id"
+
+    Bugsnag.notify(exception)
+  end
+  
+  it "should accept user_id from an exception that mixes in Bugsnag::MetaData, but override using the overrides" do
+    Bugsnag::Notification.should_receive(:deliver_exception_payload) do |endpoint, payload|
+      event = get_event_from_payload(payload)
+      event[:userId].should be == "override_user_id"
+    end
+
+    exception = BugsnagTestExceptionWithMetaData.new("It crashed")
+    exception.bugsnag_user_id = "exception_user_id"
+
+    Bugsnag.notify(exception, {:user_id => "override_user_id"})
+  end
+  
+  it "should accept context from an exception that mixes in Bugsnag::MetaData" do
+    Bugsnag::Notification.should_receive(:deliver_exception_payload) do |endpoint, payload|
+      event = get_event_from_payload(payload)
+      event[:context].should be == "exception_context"
+    end
+
+    exception = BugsnagTestExceptionWithMetaData.new("It crashed")
+    exception.bugsnag_context = "exception_context"
+
+    Bugsnag.notify(exception)
+  end
+  
+  it "should accept context from an exception that mixes in Bugsnag::MetaData, but override using the overrides" do
+    Bugsnag::Notification.should_receive(:deliver_exception_payload) do |endpoint, payload|
+      event = get_event_from_payload(payload)
+      event[:context].should be == "override_context"
+    end
+
+    exception = BugsnagTestExceptionWithMetaData.new("It crashed")
+    exception.bugsnag_context = "exception_context"
+
+    Bugsnag.notify(exception, {:context => "override_context"})
+  end
+
   it "should accept meta_data in overrides (for backwards compatibility) and merge it into metaData" do
     Bugsnag::Notification.should_receive(:deliver_exception_payload) do |endpoint, payload|
       event = get_event_from_payload(payload)
@@ -311,7 +398,7 @@ describe Bugsnag::Notification do
 
     Bugsnag.notify_or_ignore(ex)
   end
-  
+
   it "should not unwrap more than 5 exceptions" do
     Bugsnag::Notification.should_receive(:deliver_exception_payload) do |endpoint, payload|
       event = get_event_from_payload(payload)
@@ -325,4 +412,4 @@ describe Bugsnag::Notification do
 
     Bugsnag.notify_or_ignore(first_ex)
   end
-end
+end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 1
   - 2
-  - 17
-  version: 1.2.17
+  - 18
+  version: 1.2.18
 platform: ruby
 authors: 
 - James Smith
@@ -116,6 +116,7 @@ files:
 - lib/bugsnag/configuration.rb
 - lib/bugsnag/delay/resque.rb
 - lib/bugsnag/helpers.rb
+- lib/bugsnag/meta_data.rb
 - lib/bugsnag/middleware/callbacks.rb
 - lib/bugsnag/middleware/rack_request.rb
 - lib/bugsnag/middleware/rails2_request.rb