bugsnag 2.5.1 → 2.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 492b7ad630873a696cfe885ba27c95d652e8bcd2
-  data.tar.gz: aabd629b69e8dbfaf6bd528e1e22e42f56cfdc1a
+  metadata.gz: ef55d682c90467747f2be118b83bd3a85b156b1d
+  data.tar.gz: 62d482b4c71148dfe0713ea33df2289bb1f5c1fb
 SHA512:
-  metadata.gz: 91b142a6f7107413fc6b10a9764013d5c76181ca1e19fc655bad998a0d5ef26e30d5f6eae7ee11e1cc6c917a7dccf754e59e46afcb00565c6e246064014ada86
-  data.tar.gz: 015f3dba4008ae2cdafdb8bc89ff103bf5072d3688f8ee98d9ce40f1e7f1d4b2f98837b20c91ce98775f784a2487c3eb814cd7f90b59b962186ab45a3e06d42a
+  metadata.gz: 4a6af3d51710c9f736aaa59c99031f5e5a21e2b7da41182183cb4f06f3ae38fd61ce6993c460f304e35cc9398c7447b8f415c1e00da86a2fc08d0f0a42b28b7a
+  data.tar.gz: 9c15c561756b5e4feda9c6b98910010f59850dad2788d5bd9ae7ba92d3181200855b54b4e60a9b6f53a0e80c075ee6fb2932b68ac5e71e5c68f70ff4d50ee595

data/CHANGELOG.md

@@ -1,9 +1,17 @@
 Changelog
 =========
 
+2.6.0
+-----
+-   Collect and send snippets of source code to Bugsnag
+-   Fix resque integration
+-   Allow configuration of delivery method (from the default `:thread_queue` to `:synchronous`)
+-   Fix parameter filtering in rails 2
+-   Allow pathname in project root
+
 2.5.1
 -----
--   Send headers through
+-   Collect and send HTTP headers to bugsnag to help debugging
 
 2.5.0
 -----

data/README.md

@@ -552,6 +552,16 @@ send your rack environment, set the `send_environment` option to `true`.
 config.send_environment = true
 ```
 
+###send_code
+
+Bugsnag automatically sends a small snippet of the code that crashed to help you diagnose
+even faster from within your dashboard. If you don't want to send this snippet you can
+set the `send_code` option to `false`.
+
+```ruby
+config.send_code = false
+```
+
 Bugsnag Middleware
 ------------------
 

data/VERSION

@@ -1 +1 @@
-2.5.1
+2.6.0

data/bugsnag.gemspec

@@ -31,5 +31,6 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'rspec'
   s.add_development_dependency 'rdoc'
   s.add_development_dependency 'pry'
+  s.add_development_dependency 'webmock'
 end
 

data/lib/bugsnag.rb

@@ -1,13 +1,16 @@
 require "rubygems"
 
 require "bugsnag/version"
-require "bugsnag/queue"
 require "bugsnag/configuration"
 require "bugsnag/meta_data"
 require "bugsnag/notification"
 require "bugsnag/helpers"
 require "bugsnag/deploy"
 
+require "bugsnag/delivery"
+require "bugsnag/delivery/synchronous"
+require "bugsnag/delivery/thread_queue"
+
 require "bugsnag/rack"
 require "bugsnag/railtie" if defined?(Rails::Railtie)
 

data/lib/bugsnag/configuration.rb

@@ -11,6 +11,7 @@ module Bugsnag
     attr_accessor :auto_notify
     attr_accessor :use_ssl
     attr_accessor :send_environment
+    attr_accessor :send_code
     attr_accessor :project_root
     attr_accessor :app_version
     attr_accessor :app_type
@@ -27,6 +28,7 @@ module Bugsnag
     attr_accessor :proxy_password
     attr_accessor :timeout
     attr_accessor :hostname
+    attr_accessor :delivery_method
 
     attr_writer :ignore_classes
 
@@ -50,16 +52,20 @@ module Bugsnag
 
     DEFAULT_IGNORE_USER_AGENTS = [].freeze
 
+    DEFAULT_DELIVERY_METHOD = :thread_queue
+
     def initialize
       # Set up the defaults
       self.auto_notify = true
       self.use_ssl = true
       self.send_environment = false
+      self.send_code = true
       self.params_filters = Set.new(DEFAULT_PARAMS_FILTERS)
       self.ignore_classes = Set.new(DEFAULT_IGNORE_CLASSES)
       self.ignore_user_agents = Set.new(DEFAULT_IGNORE_USER_AGENTS)
       self.endpoint = DEFAULT_ENDPOINT
       self.hostname = default_hostname
+      self.delivery_method = DEFAULT_DELIVERY_METHOD
 
       # Read the API key from the environment
       self.api_key = ENV["BUGSNAG_API_KEY"]

data/lib/bugsnag/delivery.rb

@@ -0,0 +1,18 @@
+module Bugsnag
+  module Delivery
+    class << self
+      def register(name, delivery_method)
+        delivery_methods[name.to_sym] = delivery_method
+      end
+
+      def [](name)
+        delivery_methods[name.to_sym]
+      end
+
+      private
+      def delivery_methods
+        @delivery_methods ||= {}
+      end
+    end
+  end
+end

data/lib/bugsnag/delivery/synchronous.rb

@@ -0,0 +1,25 @@
+module Bugsnag
+  module Delivery
+    class Synchronous
+      HEADERS = {"Content-Type" => "application/json"}
+      TIMEOUT = 5
+
+      class << self
+        def deliver(url, body)
+          begin
+            response = HTTParty.post(url, {:body => body, :headers => HEADERS, :timeout => TIMEOUT})
+            Bugsnag.debug("Notification to #{url} finished, response was #{response.code}, payload was #{body}")
+          rescue StandardError => e
+            # KLUDGE: Since we don't re-raise http exceptions, this breaks rspec
+            raise if e.class.to_s == "RSpec::Expectations::ExpectationNotMetError"
+
+            Bugsnag.warn("Notification to #{url} failed, #{e.inspect}")
+            Bugsnag.warn(e.backtrace)
+          end
+        end
+      end
+    end
+  end
+end
+
+Bugsnag::Delivery.register(:synchronous, Bugsnag::Delivery::Synchronous)

data/lib/bugsnag/delivery/thread_queue.rb

@@ -0,0 +1,51 @@
+require "thread"
+
+module Bugsnag
+  module Delivery
+    class ThreadQueue < Synchronous
+      MAX_OUTSTANDING_REQUESTS = 100
+      STOP = Object.new
+
+      class << self
+        def deliver(url, body)
+          if queue.length > MAX_OUTSTANDING_REQUESTS
+            Bugsnag.warn("Dropping notification, #{queue.length} outstanding requests")
+            return
+          end
+
+          # Add delivery to the worker thread
+          queue.push proc { super }
+
+          # Make sure the worker thread is started
+          ensure_worker_thread_started
+        end
+
+        private
+        def queue
+          @queue ||= Queue.new
+        end
+
+        def ensure_worker_thread_started
+          unless @worker_thread
+            @worker_thread = Thread.new do
+              while x = queue.pop
+                break if x == STOP
+                x.call
+              end
+            end
+
+            at_exit do
+              Bugsnag.warn("Waiting for #{queue.length} outstanding request(s)") unless queue.empty?
+              queue.push STOP
+              @worker_thread.join
+            end
+          end
+
+          @worker_thread
+        end
+      end
+    end
+  end
+end
+
+Bugsnag::Delivery.register(:thread_queue, Bugsnag::Delivery::ThreadQueue)

data/lib/bugsnag/notification.rb

@@ -24,51 +24,23 @@ module Bugsnag
 
     CURRENT_PAYLOAD_VERSION = "2"
 
-    # HTTParty settings
-    headers  "Content-Type" => "application/json"
-    default_timeout 5
-
     attr_accessor :context
     attr_accessor :user
     attr_accessor :configuration
     attr_accessor :meta_data
 
-    @queue = Bugsnag::Queue.new
-
     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
-          # a minimal payload instead
-          if payload_string.length > 128000
-            payload[:events].each {|e| e[:metaData] = Bugsnag::Helpers.reduce_hash_size(e[:metaData])}
-            payload_string = Bugsnag::Helpers.dump_json(payload)
-          end
-
-          do_post(endpoint, payload_string)
+      def deliver_exception_payload(url, payload, configuration=Bugsnag.configuration, delivery_method=nil)
 
-        rescue StandardError => e
-          # KLUDGE: Since we don't re-raise http exceptions, this breaks rspec
-          raise if e.class.to_s == "RSpec::Expectations::ExpectationNotMetError"
-
-          Bugsnag.warn("Notification to #{endpoint} failed, #{e.inspect}")
-          Bugsnag.warn(e.backtrace)
+        # If the payload is going to be too long, we trim the hashes to send
+        # a minimal payload instead
+        payload_string = Bugsnag::Helpers.dump_json(payload)
+        if payload_string.length > 128000
+          payload[:events].each {|e| e[:metaData] = Bugsnag::Helpers.reduce_hash_size(e[:metaData])}
+          payload_string = Bugsnag::Helpers.dump_json(payload)
         end
 
-      end
-
-      def do_post(endpoint, payload_string)
-        @queue.push proc{
-          begin
-            response = post(endpoint, {:body => payload_string})
-            Bugsnag.debug("Notification to #{endpoint} finished, response was #{response.code}, payload was #{payload_string}")
-          rescue StandardError => e
-            Bugsnag.warn("Notification to #{endpoint} failed, #{e.inspect}")
-            Bugsnag.warn(e.backtrace)
-          end
-        }
+        Bugsnag::Delivery[delivery_method || configuration.delivery_method].deliver(url, payload_string)
       end
     end
 
@@ -93,6 +65,11 @@ module Bugsnag
         @overrides.delete :api_key
       end
 
+      if @overrides.key? :delivery_method
+        @delivery_method = @overrides[:delivery_method]
+        @overrides.delete :delivery_method
+      end
+
       # Unwrap exceptions
       @exceptions = []
 
@@ -272,7 +249,8 @@ module Bugsnag
           :events => [payload_event]
         }
 
-        self.class.deliver_exception_payload(endpoint, payload)
+        # Deliver the payload
+        self.class.deliver_exception_payload(endpoint, payload, @configuration, @delivery_method)
       end
     end
 
@@ -391,6 +369,10 @@ module Bugsnag
         trace_hash[:inProject] = true if @configuration.project_root && file.match(/^#{@configuration.project_root}/) && !file.match(/vendor\//)
         trace_hash[:lineNumber] = line_str.to_i
 
+        if @configuration.send_code
+          trace_hash[:code] = code(file, trace_hash[:lineNumber])
+        end
+
         # Clean up the file path in the stacktrace
         if defined?(Bugsnag.configuration.project_root) && Bugsnag.configuration.project_root.to_s != ''
           file.sub!(/#{Bugsnag.configuration.project_root}\//, "")
@@ -413,5 +395,41 @@ module Bugsnag
         end
       end.compact
     end
+
+    def code(file, line_number, num_lines = 7)
+      code_hash = {}
+
+      from_line = [line_number - num_lines, 1].max
+
+      # Populate code hash with line numbers and code lines
+      File.open(file) do |f|
+        current_line_number = 0
+        f.each_line do |line|
+          current_line_number += 1
+
+          next if current_line_number < from_line
+
+          code_hash[current_line_number] = line[0...200].rstrip
+
+          break if code_hash.length >= ( num_lines * 1.5 ).ceil
+        end
+      end
+
+      while code_hash.length > num_lines
+        last_line = code_hash.keys.max
+        first_line = code_hash.keys.min
+
+        if (last_line - line_number) > (line_number - first_line)
+          code_hash.delete(last_line)
+        else
+          code_hash.delete(first_line)
+        end
+      end
+
+      code_hash
+    rescue
+      Bugsnag.warn("Error fetching code: #{$!.inspect}")
+      nil
+    end
   end
 end

data/lib/bugsnag/rack.rb

@@ -14,7 +14,7 @@ module Bugsnag
         config.release_stage ||= ENV["RACK_ENV"] if ENV["RACK_ENV"]
 
         # Try to set the project_root if it hasn't already been set, or show a warning if we can't
-        unless config.project_root && !config.project_root.empty?
+        unless config.project_root && !config.project_root.to_s.empty?
           if defined?(settings)
             config.project_root = settings.root
           else
@@ -53,4 +53,4 @@ module Bugsnag
       Bugsnag.clear_request_data
     end
   end
-end
+end

data/lib/bugsnag/rails.rb

@@ -19,26 +19,42 @@ module Bugsnag
         ActiveRecord::Base.send(:include, Bugsnag::Rails::ActiveRecordRescue)
       end
 
-      # Try to find where to log to
-      rails_logger = nil
-      if defined?(::Rails.logger)
-        rails_logger = ::Rails.logger
-      elsif defined?(RAILS_DEFAULT_LOGGER)
-        rails_logger = RAILS_DEFAULT_LOGGER
-      end
-
       Bugsnag.configure do |config|
         config.logger ||= rails_logger
-        config.release_stage = RAILS_ENV if defined?(RAILS_ENV)
-        config.project_root = RAILS_ROOT if defined?(RAILS_ROOT)
+        config.release_stage = rails_env if rails_env
+        config.project_root = rails_root if rails_root
 
         config.middleware.insert_before(Bugsnag::Middleware::Callbacks,Bugsnag::Middleware::Rails2Request)
       end
 
       # Auto-load configuration settings from config/bugsnag.yml if it exists
-      config_file = File.join(RAILS_ROOT, "config", "bugsnag.yml")
+      config_file = File.join(rails_root, "config", "bugsnag.yml")
       config = YAML.load_file(config_file) if File.exists?(config_file)
-      Bugsnag.configure(config[RAILS_ENV] ? config[RAILS_ENV] : config) if config
+      Bugsnag.configure(config[rails_env] ? config[rails_env] : config) if config
+    end
+
+    def self.rails_logger
+      if defined?(::Rails.logger)
+        rails_logger = ::Rails.logger
+      elsif defined?(RAILS_DEFAULT_LOGGER)
+        rails_logger = RAILS_DEFAULT_LOGGER
+      end
+    end
+
+    def self.rails_env
+      if defined?(::Rails.env)
+        ::Rails.env
+      elsif defined?(RAILS_ENV)
+        RAILS_ENV
+      end
+    end
+
+    def self.rails_root
+      if defined?(::Rails.root)
+        ::Rails.root
+      elsif defined?(RAILS_ROOT)
+        RAILS_ROOT
+      end
     end
   end
 end

data/lib/bugsnag/rails/action_controller_rescue.rb

@@ -2,6 +2,8 @@
 module Bugsnag::Rails
   module ActionControllerRescue
     def self.included(base)
+      base.extend(ClassMethods)
+
       # Hook into rails exception rescue stack
       base.send(:alias_method, :rescue_action_in_public_without_bugsnag, :rescue_action_in_public)
       base.send(:alias_method, :rescue_action_in_public, :rescue_action_in_public_with_bugsnag)
@@ -30,5 +32,31 @@ module Bugsnag::Rails
 
       rescue_action_locally_without_bugsnag(exception)
     end
+
+    module ClassMethods
+
+      def self.extended(base)
+        base.singleton_class.class_eval do
+          alias_method_chain :filter_parameter_logging, :bugsnag
+        end
+      end
+
+      # Rails 2 does parameter filtering via a controller configuration method
+      # that dynamically defines a method on the controller, so the configured
+      # parameters aren't easily accessible. Intercept these parameters as
+      # they're configured so that the Bugsnag configuration can take them
+      # into account.
+      #
+      def filter_parameter_logging_with_bugsnag(*filter_words, &block)
+        if filter_words.length > 0
+          Bugsnag.configure do |config|
+            # Use the same regular expression that Rails parameter filtering uses.
+            config.params_filters << Regexp.new(filter_words.collect{ |s| s.to_s }.join('|'), true)
+          end
+        end
+        filter_parameter_logging_without_bugsnag(*filter_words, &block)
+      end
+    end
+
   end
 end