bugsnag 6.10.0 → 6.11.0

data/spec/report_spec.rb

@@ -1101,6 +1101,155 @@ describe Bugsnag::Report do
     }
   end
 
+  describe "breadcrumbs" do
+    let(:timestamp_regex) { /^\d{4}\-\d{2}\-\d{2}T\d{2}:\d{2}:[\d\.]+Z$/ }
+
+    it "includes left breadcrumbs" do
+      Bugsnag.leave_breadcrumb("Test breadcrumb")
+      notify_test_exception
+      expect(Bugsnag).to have_sent_notification { |payload, headers|
+        event = get_event_from_payload(payload)
+        expect(event["breadcrumbs"].size).to eq(1)
+        expect(event["breadcrumbs"].first).to match({
+          "name" => "Test breadcrumb",
+          "type" => "manual",
+          "metaData" => {},
+          "timestamp" => match(timestamp_regex)
+        })
+      }
+    end
+
+    it "filters left breadcrumbs" do
+      Bugsnag.leave_breadcrumb("Test breadcrumb", {
+        :forbidden_key => false,
+        :allowed_key => true
+      })
+      Bugsnag.configuration.meta_data_filters << "forbidden"
+      notify_test_exception
+      expect(Bugsnag).to have_sent_notification { |payload, headers|
+        event = get_event_from_payload(payload)
+        expect(event["breadcrumbs"].size).to eq(1)
+        expect(event["breadcrumbs"].first).to match({
+          "name" => "Test breadcrumb",
+          "type" => "manual",
+          "metaData" => {
+            "forbidden_key" => "[FILTERED]",
+            "allowed_key" => true
+          },
+          "timestamp" => match(timestamp_regex)
+        })
+      }
+    end
+
+    it "defaults to an empty array" do
+      notify_test_exception
+      expect(Bugsnag).to have_sent_notification { |payload, headers|
+        event = get_event_from_payload(payload)
+        expect(event["breadcrumbs"].size).to eq(0)
+      }
+    end
+
+    it "allows breadcrumbs to be editted in callbacks" do
+      Bugsnag.leave_breadcrumb("Test breadcrumb")
+      Bugsnag.before_notify_callbacks << Proc.new { |report|
+        breadcrumb = report.breadcrumbs.first
+        breadcrumb.meta_data = {:a => 1, :b => 2}
+      }
+      notify_test_exception
+      expect(Bugsnag).to have_sent_notification { |payload, headers|
+        event = get_event_from_payload(payload)
+        expect(event["breadcrumbs"].size).to eq(1)
+        expect(event["breadcrumbs"].first).to match({
+          "name" => "Test breadcrumb",
+          "type" => "manual",
+          "metaData" => {"a" => 1, "b" => 2},
+          "timestamp" => match(timestamp_regex)
+        })
+      }
+    end
+  end
+
+  describe "#summary" do
+    it "provides a hash of the name, message, and severity" do
+      begin
+        1/0
+      rescue ZeroDivisionError => e
+        report = Bugsnag::Report.new(e, Bugsnag.configuration)
+
+        expect(report.summary).to eq({
+          :error_class => "ZeroDivisionError",
+          :message => "divided by 0",
+          :severity => "warning"
+        })
+      end
+    end
+
+    it "handles strings" do
+      report = Bugsnag::Report.new("test string", Bugsnag.configuration)
+
+      expect(report.summary).to eq({
+        :error_class => "RuntimeError",
+        :message => "test string",
+        :severity => "warning"
+      })
+    end
+
+    it "handles error edge cases" do
+      report = Bugsnag::Report.new(Timeout::Error, Bugsnag.configuration)
+
+      expect(report.summary).to eq({
+        :error_class => "Timeout::Error",
+        :message => "Timeout::Error",
+        :severity => "warning"
+      })
+    end
+
+    it "handles empty exceptions" do
+      begin
+        1/0
+      rescue ZeroDivisionError => e
+        report = Bugsnag::Report.new(e, Bugsnag.configuration)
+
+        report.exceptions = []
+
+        expect(report.summary).to eq({
+          :error_class => "Unknown",
+          :severity => "warning"
+        })
+      end
+    end
+
+    it "handles removed exceptions" do
+      begin
+        1/0
+      rescue ZeroDivisionError => e
+        report = Bugsnag::Report.new(e, Bugsnag.configuration)
+
+        report.exceptions = nil
+
+        expect(report.summary).to eq({
+          :error_class => "Unknown",
+          :severity => "warning"
+        })
+      end
+    end
+
+    it "handles exceptions being replaced" do
+      begin
+        1/0
+      rescue ZeroDivisionError => e
+        report = Bugsnag::Report.new(e, Bugsnag.configuration)
+
+        report.exceptions = "no one should ever do this"
+
+        expect(report.summary).to eq({
+          :error_class => "Unknown",
+          :severity => "warning"
+        })
+      end
+    end
+  end
+
   if defined?(JRUBY_VERSION)
 
     it "should work with java.lang.Throwables" do

data/spec/session_tracker_spec.rb

@@ -2,6 +2,14 @@
 require 'webrick'
 require 'spec_helper'
 require 'json'
+require 'concurrent'
+
+# Enable reset of session_counts between each example
+module Bugsnag
+  class SessionTracker
+    attr_accessor :session_counts
+  end
+end
 
 describe Bugsnag::SessionTracker do
   server = nil
@@ -19,6 +27,10 @@ describe Bugsnag::SessionTracker do
     Thread.new{ server.start }
   end
 
+  after(:each) do
+    Bugsnag.instance_variable_set(:@session_tracker, Bugsnag::SessionTracker.new)
+  end
+
   after do
     Bugsnag.configure do |conf|
       conf.auto_capture_sessions = false
@@ -60,11 +72,21 @@ describe Bugsnag::SessionTracker do
     expect(session_one[:id]).to_not eq(session_two[:id])
   end
 
+  it 'will not create sessions if Configuration.enable_sessions is false' do
+    Bugsnag.configure do |conf|
+      conf.set_endpoints("http://localhost:#{server.config[:Port]}", nil)
+    end
+    expect(Bugsnag.configuration.enable_sessions).to eq(false)
+    expect(Bugsnag.session_tracker.session_counts.size).to eq(0)
+    Bugsnag.start_session
+    expect(Bugsnag.session_tracker.session_counts.size).to eq(0)
+  end
+
   it 'sends sessions when send_sessions is called' do
     Bugsnag.configure do |conf|
       conf.auto_capture_sessions = true
       conf.delivery_method = :synchronous
-      conf.session_endpoint = "http://localhost:#{server.config[:Port]}"
+      conf.set_endpoints("http://localhost:#{server.config[:Port]}", "http://localhost:#{server.config[:Port]}")
     end
     WebMock.allow_net_connect!
     Bugsnag.start_session
@@ -84,7 +106,7 @@ describe Bugsnag::SessionTracker do
       conf.auto_capture_sessions = true
       conf.release_stage = "test_stage"
       conf.delivery_method = :synchronous
-      conf.session_endpoint = "http://localhost:#{server.config[:Port]}"
+      conf.set_endpoints("http://localhost:#{server.config[:Port]}", "http://localhost:#{server.config[:Port]}")
     end
     WebMock.allow_net_connect!
     Bugsnag.start_session

data/spec/utility/circular_buffer_spec.rb

@@ -0,0 +1,98 @@
+# encoding: utf-8
+
+require 'spec_helper'
+require 'bugsnag/utility/circular_buffer'
+
+RSpec.describe Bugsnag::Utility::CircularBuffer do
+  describe "#initialize" do
+    it "contains no items" do
+      buffer = Bugsnag::Utility::CircularBuffer.new
+
+      expect(buffer.to_a).to eq([])
+    end
+  end
+
+  describe "#max_items" do
+    it "defaults to 25" do
+      buffer = Bugsnag::Utility::CircularBuffer.new
+
+      expect(buffer.max_items).to equal 25
+    end
+
+    it "can be set during #initialize" do
+      buffer = Bugsnag::Utility::CircularBuffer.new(10)
+
+      expect(buffer.max_items).to equal 10
+    end
+  end
+
+  describe "#max_items=" do
+    it "changes #max_items" do
+      buffer = Bugsnag::Utility::CircularBuffer.new(10)
+      buffer.max_items = 17
+
+      expect(buffer.max_items).to equal(17)
+    end
+
+    it "shifts any excess items when reduced" do
+      buffer = Bugsnag::Utility::CircularBuffer.new(10)
+      (0...10).each { |x| buffer << x }
+      buffer.max_items = 3
+
+      expect(buffer.to_a).to eq([7, 8, 9])
+    end
+
+    it "increases the maximum capacity" do
+      buffer = Bugsnag::Utility::CircularBuffer.new(3)
+      buffer << 1
+      buffer << 2
+      buffer << 3
+
+      expect(buffer.to_a).to eq([1, 2, 3])
+
+      buffer.max_items = 5
+      buffer << 4
+      buffer << 5
+
+      expect(buffer.to_a).to eq([1, 2, 3, 4, 5])
+    end
+  end
+
+  describe "#<<" do
+    it "adds items to the buffer" do
+      buffer = Bugsnag::Utility::CircularBuffer.new
+      buffer << 1
+      expect(buffer.to_a).to eq([1])
+    end
+
+    it "shifts items it #max_items is exceeded" do
+      buffer = Bugsnag::Utility::CircularBuffer.new(5)
+      (0...10).each { |x| buffer << x }
+
+      expect(buffer.to_a).to eq([5, 6, 7, 8, 9])
+    end
+
+    it "can be chained" do
+      buffer = Bugsnag::Utility::CircularBuffer.new
+      buffer << 1 << 2 << 3 << 4 << 5
+
+      expect(buffer.to_a).to eq([1, 2, 3, 4, 5])
+    end
+  end
+
+  describe "#each" do
+    it "can be iterated over" do
+      buffer = Bugsnag::Utility::CircularBuffer.new
+      buffer << 1
+      buffer << 2
+      buffer << 3
+
+      output = []
+      buffer.each do |x|
+        output << x
+      end
+
+      expect(output).to eq([1, 2, 3])
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bugsnag
 version: !ruby/object:Gem::Version
-  version: 6.10.0
+  version: 6.11.0
 platform: ruby
 authors:
 - James Smith
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-05 00:00:00.000000000 Z
+date: 2019-01-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -210,6 +210,7 @@ files:
 - features/fixtures/rails3/app/app/controllers/application_controller.rb
 - features/fixtures/rails3/app/app/controllers/auto_notify_controller.rb
 - features/fixtures/rails3/app/app/controllers/before_notify_controller.rb
+- features/fixtures/rails3/app/app/controllers/breadcrumbs_controller.rb
 - features/fixtures/rails3/app/app/controllers/handled_controller.rb
 - features/fixtures/rails3/app/app/controllers/ignore_classes_controller.rb
 - features/fixtures/rails3/app/app/controllers/metadata_filters_controller.rb
@@ -269,11 +270,13 @@ files:
 - features/fixtures/rails4/app/app/controllers/application_controller.rb
 - features/fixtures/rails4/app/app/controllers/auto_notify_controller.rb
 - features/fixtures/rails4/app/app/controllers/before_notify_controller.rb
+- features/fixtures/rails4/app/app/controllers/breadcrumbs_controller.rb
 - features/fixtures/rails4/app/app/controllers/concerns/.keep
 - features/fixtures/rails4/app/app/controllers/devise_controller.rb
 - features/fixtures/rails4/app/app/controllers/handled_controller.rb
 - features/fixtures/rails4/app/app/controllers/ignore_classes_controller.rb
 - features/fixtures/rails4/app/app/controllers/metadata_filters_controller.rb
+- features/fixtures/rails4/app/app/controllers/mongo_controller.rb
 - features/fixtures/rails4/app/app/controllers/project_root_controller.rb
 - features/fixtures/rails4/app/app/controllers/release_stage_controller.rb
 - features/fixtures/rails4/app/app/controllers/send_code_controller.rb
@@ -281,9 +284,12 @@ files:
 - features/fixtures/rails4/app/app/controllers/session_tracking_controller.rb
 - features/fixtures/rails4/app/app/controllers/unhandled_controller.rb
 - features/fixtures/rails4/app/app/helpers/application_helper.rb
+- features/fixtures/rails4/app/app/jobs/application_job.rb
+- features/fixtures/rails4/app/app/jobs/notify_job.rb
 - features/fixtures/rails4/app/app/mailers/.keep
 - features/fixtures/rails4/app/app/models/.keep
 - features/fixtures/rails4/app/app/models/concerns/.keep
+- features/fixtures/rails4/app/app/models/mongo_model.rb
 - features/fixtures/rails4/app/app/models/user.rb
 - features/fixtures/rails4/app/app/views/layouts/application.html.erb
 - features/fixtures/rails4/app/config.ru
@@ -306,6 +312,7 @@ files:
 - features/fixtures/rails4/app/config/initializers/wrap_parameters.rb
 - features/fixtures/rails4/app/config/locales/devise.en.yml
 - features/fixtures/rails4/app/config/locales/en.yml
+- features/fixtures/rails4/app/config/mongoid.yml
 - features/fixtures/rails4/app/config/routes.rb
 - features/fixtures/rails4/app/db/migrate/20180420160315_devise_create_users.rb
 - features/fixtures/rails4/app/db/seeds.rb
@@ -344,11 +351,13 @@ files:
 - features/fixtures/rails5/app/app/controllers/application_controller.rb
 - features/fixtures/rails5/app/app/controllers/auto_notify_controller.rb
 - features/fixtures/rails5/app/app/controllers/before_notify_controller.rb
+- features/fixtures/rails5/app/app/controllers/breadcrumbs_controller.rb
 - features/fixtures/rails5/app/app/controllers/clearance_controller.rb
 - features/fixtures/rails5/app/app/controllers/concerns/.keep
 - features/fixtures/rails5/app/app/controllers/handled_controller.rb
 - features/fixtures/rails5/app/app/controllers/ignore_classes_controller.rb
 - features/fixtures/rails5/app/app/controllers/metadata_filters_controller.rb
+- features/fixtures/rails5/app/app/controllers/mongo_controller.rb
 - features/fixtures/rails5/app/app/controllers/project_root_controller.rb
 - features/fixtures/rails5/app/app/controllers/release_stage_controller.rb
 - features/fixtures/rails5/app/app/controllers/send_code_controller.rb
@@ -357,9 +366,11 @@ files:
 - features/fixtures/rails5/app/app/controllers/unhandled_controller.rb
 - features/fixtures/rails5/app/app/helpers/application_helper.rb
 - features/fixtures/rails5/app/app/jobs/application_job.rb
+- features/fixtures/rails5/app/app/jobs/notify_job.rb
 - features/fixtures/rails5/app/app/mailers/application_mailer.rb
 - features/fixtures/rails5/app/app/models/application_record.rb
 - features/fixtures/rails5/app/app/models/concerns/.keep
+- features/fixtures/rails5/app/app/models/mongo_model.rb
 - features/fixtures/rails5/app/app/models/user.rb
 - features/fixtures/rails5/app/app/views/layouts/application.html.erb
 - features/fixtures/rails5/app/app/views/layouts/mailer.html.erb
@@ -387,6 +398,7 @@ files:
 - features/fixtures/rails5/app/config/initializers/wrap_parameters.rb
 - features/fixtures/rails5/app/config/locales/devise.en.yml
 - features/fixtures/rails5/app/config/locales/en.yml
+- features/fixtures/rails5/app/config/mongoid.yml
 - features/fixtures/rails5/app/config/puma.rb
 - features/fixtures/rails5/app/config/routes.rb
 - features/fixtures/rails5/app/config/secrets.yml
@@ -460,9 +472,11 @@ files:
 - features/rails_features/auto_capture_sessions.feature
 - features/rails_features/auto_notify.feature
 - features/rails_features/before_notify.feature
+- features/rails_features/breadcrumbs.feature
 - features/rails_features/handled.feature
 - features/rails_features/ignore_classes.feature
 - features/rails_features/meta_data_filters.feature
+- features/rails_features/mongo_breadcrumbs.feature
 - features/rails_features/project_root.feature
 - features/rails_features/release_stage.feature
 - features/rails_features/send_code.feature
@@ -474,6 +488,9 @@ files:
 - features/support/env.rb
 - issue_template.md
 - lib/bugsnag.rb
+- lib/bugsnag/breadcrumbs/breadcrumb.rb
+- lib/bugsnag/breadcrumbs/breadcrumbs.rb
+- lib/bugsnag/breadcrumbs/validator.rb
 - lib/bugsnag/cleaner.rb
 - lib/bugsnag/configuration.rb
 - lib/bugsnag/delivery.rb
@@ -482,16 +499,19 @@ files:
 - lib/bugsnag/helpers.rb
 - lib/bugsnag/integrations/delayed_job.rb
 - lib/bugsnag/integrations/mailman.rb
+- lib/bugsnag/integrations/mongo.rb
 - lib/bugsnag/integrations/que.rb
 - lib/bugsnag/integrations/rack.rb
 - lib/bugsnag/integrations/rails/active_record_rescue.rb
 - lib/bugsnag/integrations/rails/controller_methods.rb
+- lib/bugsnag/integrations/rails/rails_breadcrumbs.rb
 - lib/bugsnag/integrations/railtie.rb
 - lib/bugsnag/integrations/rake.rb
 - lib/bugsnag/integrations/resque.rb
 - lib/bugsnag/integrations/shoryuken.rb
 - lib/bugsnag/integrations/sidekiq.rb
 - lib/bugsnag/meta_data.rb
+- lib/bugsnag/middleware/breadcrumbs.rb
 - lib/bugsnag/middleware/callbacks.rb
 - lib/bugsnag/middleware/classify_error.rb
 - lib/bugsnag/middleware/clearance_user.rb
@@ -512,8 +532,11 @@ files:
 - lib/bugsnag/stacktrace.rb
 - lib/bugsnag/tasks.rb
 - lib/bugsnag/tasks/bugsnag.rake
+- lib/bugsnag/utility/circular_buffer.rb
 - lib/bugsnag/version.rb
 - lib/generators/bugsnag/bugsnag_generator.rb
+- spec/breadcrumbs/breadcrumb_spec.rb
+- spec/breadcrumbs/validator_spec.rb
 - spec/bugsnag_spec.rb
 - spec/cleaner_spec.rb
 - spec/configuration_spec.rb
@@ -540,6 +563,7 @@ files:
 - spec/integrations/clearance_user_spec.rb
 - spec/integrations/logger_spec.rb
 - spec/integrations/mailman_spec.rb
+- spec/integrations/mongo_spec.rb
 - spec/integrations/que_spec.rb
 - spec/integrations/rack_spec.rb
 - spec/integrations/rails3_request_spec.rb
@@ -555,6 +579,7 @@ files:
 - spec/session_tracker_spec.rb
 - spec/spec_helper.rb
 - spec/stacktrace_spec.rb
+- spec/utility/circular_buffer_spec.rb
 homepage: https://github.com/bugsnag/bugsnag-ruby
 licenses:
 - MIT