bugsnag 6.6.3 → 6.6.4

data/lib/bugsnag/middleware/clearance_user.rb

@@ -1,4 +1,6 @@
 module Bugsnag::Middleware
+  ##
+  # Extracts and appends clearance user information
   class ClearanceUser
     COMMON_USER_FIELDS = [:email, :name, :first_name, :last_name, :created_at, :id]
 

data/lib/bugsnag/middleware/exception_meta_data.rb

@@ -1,4 +1,6 @@
 module Bugsnag::Middleware
+  ##
+  # Extracts data from the exception.
   class ExceptionMetaData
     def initialize(bugsnag)
       @bugsnag = bugsnag
@@ -7,23 +9,21 @@ module Bugsnag::Middleware
     def call(report)
       # Apply the user's information attached to the exceptions
       report.raw_exceptions.each do |exception|
-        if exception.class.include?(Bugsnag::MetaData)
-          if exception.bugsnag_user_id.is_a?(String)
-            report.user = {id: exception.bugsnag_user_id}
-          end
+        if exception.respond_to?(:bugsnag_user_id) && exception.bugsnag_user_id.is_a?(String)
+          report.user = {id: exception.bugsnag_user_id}
+        end
 
-          if exception.bugsnag_context.is_a?(String)
-            report.context = exception.bugsnag_context
-          end
+        if exception.respond_to?(:bugsnag_context) && exception.bugsnag_context.is_a?(String)
+          report.context = exception.bugsnag_context
+        end
 
-          if exception.bugsnag_grouping_hash.is_a?(String)
-            report.grouping_hash = exception.bugsnag_grouping_hash
-          end
+        if exception.respond_to?(:bugsnag_grouping_hash) && exception.bugsnag_grouping_hash.is_a?(String)
+          report.grouping_hash = exception.bugsnag_grouping_hash
+        end
 
-          if exception.respond_to?(:bugsnag_meta_data) && exception.bugsnag_meta_data
-            exception.bugsnag_meta_data.each do |key, value|
-              report.add_tab key, value
-            end
+        if exception.respond_to?(:bugsnag_meta_data) && exception.bugsnag_meta_data.is_a?(Hash)
+          exception.bugsnag_meta_data.each do |key, value|
+            report.add_tab key, value
           end
         end
       end

data/lib/bugsnag/middleware/ignore_error_class.rb

@@ -1,4 +1,7 @@
 module Bugsnag::Middleware
+  ##
+  # Determines if the exception should be ignored based on the configured
+  # `ignore_classes`
   class IgnoreErrorClass
     def initialize(bugsnag)
       @bugsnag = bugsnag

data/lib/bugsnag/middleware/mailman.rb

@@ -1,4 +1,6 @@
 module Bugsnag::Middleware
+  ##
+  # Extracts and attaches mailman data to an error report
   class Mailman
     def initialize(bugsnag)
       @bugsnag = bugsnag

data/lib/bugsnag/middleware/rack_request.rb

@@ -1,4 +1,6 @@
 module Bugsnag::Middleware
+  ##
+  # Extracts and attaches rack data to an error report
   class RackRequest
     SPOOF = "[SPOOF]".freeze
 

data/lib/bugsnag/middleware/rails3_request.rb

@@ -1,4 +1,6 @@
 module Bugsnag::Middleware
+  ##
+  # Extracts and attaches rails and rack environment data to an error report
   class Rails3Request
     SPOOF = "[SPOOF]".freeze
 

data/lib/bugsnag/middleware/rake.rb

@@ -1,4 +1,6 @@
 module Bugsnag::Middleware
+  ##
+  # Extracts and attaches rake task information to an error report
   class Rake
     def initialize(bugsnag)
       @bugsnag = bugsnag

data/lib/bugsnag/middleware/session_data.rb

@@ -1,4 +1,6 @@
 module Bugsnag::Middleware
+  ##
+  # Attaches information about current session to an error report
   class SessionData
     def initialize(bugsnag)
       @bugsnag = bugsnag

data/lib/bugsnag/middleware/sidekiq.rb

@@ -1,4 +1,6 @@
 module Bugsnag::Middleware
+  ##
+  # Attaches Sidekiq job information to an error report
   class Sidekiq
     def initialize(bugsnag)
       @bugsnag = bugsnag

data/lib/bugsnag/middleware/suggestion_data.rb

@@ -1,4 +1,6 @@
 module Bugsnag::Middleware
+  ##
+  # Attaches any "Did you mean?" suggestions to the report
   class SuggestionData
 
     CAPTURE_REGEX = /Did you mean\?([\s\S]+)$/

data/lib/bugsnag/middleware/warden_user.rb

@@ -1,4 +1,6 @@
 module Bugsnag::Middleware
+  ##
+  # Extracts and attaches user information from Warden to an error report
   class WardenUser
     SCOPE_PATTERN = /^warden\.user\.([^.]+)\.key$/
     COMMON_USER_FIELDS = [:email, :name, :first_name, :last_name, :created_at, :id]

data/lib/bugsnag/middleware_stack.rb

@@ -1,11 +1,17 @@
 module Bugsnag
   class MiddlewareStack
+    ##
+    # Creates the middleware stack.
     def initialize
       @middlewares = []
       @disabled_middleware = []
       @mutex = Mutex.new
     end
 
+    ##
+    # Defines a new middleware to use in the middleware call sequence.
+    #
+    # Will return early if given middleware is disabled or already included.
     def use(new_middleware)
       @mutex.synchronize do
         return if @disabled_middleware.include?(new_middleware)
@@ -15,6 +21,11 @@ module Bugsnag
       end
     end
 
+    ##
+    # Inserts a new middleware to use after a given middleware already added.
+    #
+    # Will return early if given middleware is disabled or already added.
+    # New middleware will be inserted last if the existing middleware is not already included.
     def insert_after(after, new_middleware)
       @mutex.synchronize do
         return if @disabled_middleware.include?(new_middleware)
@@ -34,6 +45,11 @@ module Bugsnag
       end
     end
 
+    ##
+    # Inserts a new middleware to use before a given middleware already added.
+    #
+    # Will return early if given middleware is disabled or already added.
+    # New middleware will be inserted last if the existing middleware is not already included.
     def insert_before(before, new_middleware)
       @mutex.synchronize do
         return if @disabled_middleware.include?(new_middleware)
@@ -57,12 +73,14 @@ module Bugsnag
       end
     end
 
-    # This allows people to proxy methods to the array if they want to do more complex stuff
+    ##
+    # Allows the user to proxy methods for more complex functionality.
     def method_missing(method, *args, &block)
       @middlewares.send(method, *args, &block)
     end
 
-    # Runs the middleware stack and calls
+    ##
+    # Runs the middleware stack.
     def run(report)
       # The final lambda is the termination of the middleware stack. It calls deliver on the notification
       lambda_has_run = false

data/lib/bugsnag/report.rb

@@ -37,6 +37,8 @@ module Bugsnag
     attr_accessor :severity_reason
     attr_accessor :user
 
+    ##
+    # Initializes a new report from an exception.
     def initialize(exception, passed_configuration, auto_notify=false)
       @should_ignore = false
       @unhandled = auto_notify
@@ -58,7 +60,8 @@ module Bugsnag
       self.user = {}
     end
 
-    # Add a new tab to this notification
+    ##
+    # Add a new metadata tab to this notification.
     def add_tab(name, value)
       return if name.nil?
 
@@ -72,14 +75,16 @@ module Bugsnag
       end
     end
 
-    # Remove a tab from this notification
+    ##
+    # Removes a metadata tab from this notification.
     def remove_tab(name)
       return if name.nil?
 
       meta_data.delete(name)
     end
 
-    # Build an exception payload
+    ##
+    # Builds and returns the exception payload for this notification.
     def as_json
       # Build the payload's exception event
       payload_event = {
@@ -120,6 +125,8 @@ module Bugsnag
       }
     end
 
+    ##
+    # Returns the headers required for the notification.
     def headers
       {
         "Bugsnag-Api-Key" => api_key,
@@ -128,14 +135,20 @@ module Bugsnag
       }
     end
 
+    ##
+    # Whether this report should be ignored and not sent.
     def ignore?
       @should_ignore
     end
 
+    ##
+    # Data set on the configuration to be attached to every error notification.
     def request_data
       configuration.request_data
     end
 
+    ##
+    # Tells the client this report should not be sent.
     def ignore!
       @should_ignore = true
     end

data/lib/bugsnag/session_tracker.rb

@@ -12,18 +12,28 @@ module Bugsnag
 
     attr_reader :session_counts
 
+    ##
+    # Sets the session information for this thread.
     def self.set_current_session(session)
       Thread.current[THREAD_SESSION] = session
     end
 
+    ##
+    # Returns the session information for this thread.
     def self.get_current_session
       Thread.current[THREAD_SESSION]
     end
 
+    ##
+    # Initializes the session tracker.
     def initialize
       @session_counts = Concurrent::Hash.new(0)
     end
 
+    ##
+    # Starts a new session, storing it on the current thread.
+    #
+    # This allows Bugsnag to track error rates for a release.
     def start_session
       start_delivery_thread
       start_time = Time.now().utc().strftime('%Y-%m-%dT%H:%M:00')
@@ -41,6 +51,8 @@ module Bugsnag
 
     alias_method :create_session, :start_session
 
+    ##
+    # Delivers the current session_counts lists to the session endpoint.
     def send_sessions
       sessions = []
       counts = @session_counts
@@ -54,6 +66,7 @@ module Bugsnag
       deliver(sessions)
     end
 
+    private
     def start_delivery_thread
       MUTEX.synchronize do
         @started = nil unless defined?(@started)
@@ -77,7 +90,6 @@ module Bugsnag
       end
     end
 
-    private
     def add_session(min)
       @session_counts[min] += 1
     end

data/lib/bugsnag/stacktrace.rb

@@ -8,8 +8,10 @@ module Bugsnag
     JAVA_BACKTRACE_REGEX = /^(.*)\((.*)(?::([0-9]+))?\)$/
 
     # Path to vendored code. Used to mark file paths as out of project.
-    VENDOR_PATH = 'vendor/'
+    VENDOR_PATH = /^(vendor\/|\.bundle\/)/
 
+    ##
+    # Process a backtrace and the configuration into a parsed stacktrace.
     def initialize(backtrace, configuration)
       @configuration = configuration
 
@@ -44,7 +46,7 @@ module Bugsnag
         if defined?(@configuration.project_root) && @configuration.project_root.to_s != ''
           trace_hash[:inProject] = true if file.start_with?(@configuration.project_root.to_s)
           file.sub!(/#{@configuration.project_root}\//, "")
-          trace_hash.delete(:inProject) if file.start_with?(VENDOR_PATH)
+          trace_hash.delete(:inProject) if file.match(VENDOR_PATH)
         end
 
 
@@ -66,6 +68,8 @@ module Bugsnag
       end.compact
     end
 
+    ##
+    # Returns the processed backtrace
     def to_a
       @processed_backtrace
     end

data/spec/middleware/exception_meta_data_spec.rb

@@ -0,0 +1,104 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe Bugsnag::Middleware::ExceptionMetaData do
+  let(:report_class) do
+    Class.new do
+      attr_accessor :raw_exceptions, :tabs, :user, :context, :grouping_hash
+
+      def initialize(errors)
+        self.raw_exceptions = Array(errors)
+      end
+
+      def add_tab(key, value)
+        self.tabs ||= {}
+        tabs[key] = value
+      end
+    end
+  end
+
+  let(:middleware) { Bugsnag::Middleware::ExceptionMetaData.new(lambda {|_|}) }
+  let(:bugsnag_error_class) { Class.new(StandardError) { include Bugsnag::MetaData } }
+
+  it "adds metadata when exception singleton class extended with Bugsnag::MetaData" do
+    error = RuntimeError.new
+    error.extend(Bugsnag::MetaData)
+    error.bugsnag_meta_data = {"foo" => "bar"}
+
+    report = report_class.new(error)
+
+    middleware.call(report)
+
+    expect(report.tabs).to eq({"foo" => "bar"})
+  end
+
+  it "adds metadata when exception class includes Bugsnag::MetaData" do
+    error = bugsnag_error_class.new
+    error.bugsnag_meta_data = {"foo" => "bar"}
+
+    report = report_class.new(error)
+
+    middleware.call(report)
+
+    expect(report.tabs).to eq({"foo" => "bar"})
+  end
+
+  it "does nothing when metadata not a Hash" do
+    error = bugsnag_error_class.new
+    error.bugsnag_meta_data = 4
+
+    report = report_class.new(error)
+
+    middleware.call(report)
+
+    expect(report.user).to eq(nil)
+    expect(report.tabs).to eq(nil)
+    expect(report.grouping_hash).to eq(nil)
+    expect(report.context).to eq(nil)
+  end
+
+  it "sets user ID when a string" do
+    error = bugsnag_error_class.new
+    error.bugsnag_user_id = "1234"
+
+    report = report_class.new(error)
+
+    middleware.call(report)
+
+    expect(report.user).to eq({id: "1234"})
+  end
+
+  it "sets context when a string" do
+    error = bugsnag_error_class.new
+    error.bugsnag_context = "Foo#bar"
+
+    report = report_class.new(error)
+
+    middleware.call(report)
+
+    expect(report.context).to eq("Foo#bar")
+  end
+
+  it "sets grouping_hash when a string" do
+    error = bugsnag_error_class.new
+    error.bugsnag_grouping_hash = "abcdef"
+
+    report = report_class.new(error)
+
+    middleware.call(report)
+
+    expect(report.grouping_hash).to eq("abcdef")
+  end
+
+  it "does nothing when no bugsnag attributes are set" do
+    error = bugsnag_error_class.new
+    report = report_class.new(error)
+
+    middleware.call(report)
+
+    expect(report.user).to eq(nil)
+    expect(report.tabs).to eq(nil)
+    expect(report.grouping_hash).to eq(nil)
+    expect(report.context).to eq(nil)
+  end
+end

data/spec/report_spec.rb

@@ -536,6 +536,10 @@ describe Bugsnag::Report do
       File.join(project_root, "lib/helpers/string.rb:32:in `splice'"),
       File.join(project_root, "lib/vendor/lib/article.rb:158:in `initialize'"),
       File.join(project_root, "lib/prog.rb:158:in `read_articles'"),
+      File.join(project_root, ".bundle/strutils/lib.string.rb:508:in `splice'"),
+      File.join(project_root, "abundle/article.rb:158:in `initialize'"),
+      File.join(project_root, ".bundles/strutils/lib.string.rb:508:in `splice'"),
+      File.join(project_root, "lib/.bundle/article.rb:158:in `initialize'"),
       "app.rb:10:in `main'",
       "(pry):3:in `__pry__'"
     ]}
@@ -549,7 +553,11 @@ describe Bugsnag::Report do
       expect(exception["stacktrace"][3]["inProject"]).to be true
       expect(exception["stacktrace"][4]["inProject"]).to be true
       expect(exception["stacktrace"][5]["inProject"]).to be_nil
-      expect(exception["stacktrace"][6]["inProject"]).to be_nil
+      expect(exception["stacktrace"][6]["inProject"]).to be true
+      expect(exception["stacktrace"][7]["inProject"]).to be true
+      expect(exception["stacktrace"][8]["inProject"]).to be true
+      expect(exception["stacktrace"][9]["inProject"]).to be_nil
+      expect(exception["stacktrace"][10]["inProject"]).to be_nil
     }
   end