bugsnag 6.10.0 → 6.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ce226017ad134f5f882d4c5cd347871e04daac3270d032db298de2b23a5abc97
-  data.tar.gz: a5b2a379fafe7bd51b8d2d8ca762ccda6f19ac5beb1b9d6ac607fd85e8768a2f
+  metadata.gz: fc8a84dd1c666154aabc8e2a259f195e002b536d65c26c7e2a4399f988da37c0
+  data.tar.gz: c57acd7af26a27dcdc8649d8822f707f146f77d02fa01356941cf4cd4f9d8293
 SHA512:
-  metadata.gz: f94232a1d4f0c98df012d75ff19b02bfaf0133b3cc93b4e0b0285e9455ce52e40bb94b5f7cd1742841777f24ccfb0a7a01cc7756e618a4693675bad8e5dc378d
-  data.tar.gz: d9840980489c43a139d92e9573be4eb5ba36c34d1a4b79874fc96176d1d1ab20ba4d1fd2c179d92ae08645276543a899b41e9ce3e62520d9ca7a0292c140ab17
+  metadata.gz: f1af419ae0b0fdc8b6284463a2945369564b5af5255aaeda4141f197787972d3483514a4db99e2a5dc9b6cba50ebd237bcdfe5509b738772954c25acdaa7582e
+  data.tar.gz: 845838f4f41b3893b95067437825c9af1ab4e634194d0cd81276784fde73e6227d1665da89c68d15e40181c257ec23eab7c857ff77225a9cfd52a7d1bbffb75d

data/.rubocop_todo.yml

@@ -289,6 +289,9 @@ Metrics/BlockNesting:
 # Configuration parameters: CountComments.
 Metrics/ClassLength:
   Max: 149
+  Exclude:
+    - 'lib/bugsnag/report.rb'
+    - 'lib/bugsnag/configuration.rb'
 
 # Offense count: 12
 Metrics/CyclomaticComplexity:
@@ -305,6 +308,7 @@ Metrics/ModuleLength:
   Max: 125
   Exclude:
     - 'lib/bugsnag/helpers.rb'
+    - 'lib/bugsnag.rb'
 
 # Offense count: 11
 Metrics/PerceivedComplexity:

data/CHANGELOG.md

@@ -1,6 +1,26 @@
 Changelog
 =========
 
+## 6.11.0 (17 Jan 2019)
+
+**Note**: this release alters the behaviour of the notifier to track sessions automatically.
+
+### Enhancements
+
+* Added Breadcrumbs.  Breadcrumbs allow you to track events that may have led
+up to an error, such as handled errors, page redirects, or SQL queries. For info on what
+is tracked and how you can customize the data that breadcrumbs collect, see the
+[Logging breadcrumbs](https://docs.bugsnag.com/platforms/ruby/other#logging-breadcrumbs)
+section of our documentation.
+  | [#525](https://github.com/bugsnag/bugsnag-ruby/pull/525)
+
+* Bugsnag will now capture automatically created sessions by default.
+  | [#523](https://github.com/bugsnag/bugsnag-ruby/pull/523)
+
+### Deprecated
+
+* The `endpoint` and `session_endpoint` configuration options are now deprecated but still supported. The [`set_endpoints`](https://docs.bugsnag.com/platforms/ruby/other/configuration-options#endpoints) method should be used instead. Note that session tracking will be disabled if the notify endpoint is configured but the sessions endpoint is not - this is to avoid inadvertently sending session payloads to the wrong server.
+
 ## 6.10.0 (05 Dec 2018)
 
 ### Enhancements

data/Gemfile

@@ -8,6 +8,7 @@ group :test, optional: true do
     gem 'pry'
     gem 'addressable', '~> 2.3.8'
     gem 'delayed_job' if RUBY_VERSION >= '2.2.2'
+    gem 'i18n', RUBY_VERSION <= '2.3.0' ? '1.4.0': '>1.4.0' if RUBY_VERSION >= '2.2.2'
     gem 'webmock', RUBY_VERSION <= '1.9.3' ? '2.3.2': '>2.3.2'
 end
 

data/README.md

@@ -10,6 +10,7 @@ The Bugsnag exception reporter for Ruby gives you instant notification of except
 * Report handled exceptions
 * Attach user information to determine how many people are affected by a crash
 * Send customized diagnostic data
+* Track events that occur leading up to a crash
 
 ## Getting started
 

data/VERSION

@@ -1 +1 @@
-6.10.0
+6.11.0

data/features/fixtures/docker-compose.yml

@@ -4,6 +4,9 @@ services:
   redis:
     image: redis
 
+  mongo:
+    image: mongo
+
   plain-ruby:
     build:
       context: plain
@@ -117,6 +120,8 @@ services:
       - BUGSNAG_SESSION_ENDPOINT
       - BUGSNAG_TIMEOUT
       - CALLBACK_INITIATOR
+      - SQL_ONLY_BREADCRUMBS
+      - USE_DEFAULT_AUTO_CAPTURE_SESSIONS
     ports:
       - target: 3000
         published: 61283
@@ -128,6 +133,8 @@ services:
       args:
         - RUBY_VERSION
         - APP_PATH
+    depends_on:
+      - mongo
     environment:
       - BUGSNAG_API_KEY
       - http_proxy
@@ -152,6 +159,8 @@ services:
       - BUGSNAG_SESSION_ENDPOINT
       - BUGSNAG_TIMEOUT
       - CALLBACK_INITIATOR
+      - SQL_ONLY_BREADCRUMBS
+      - USE_DEFAULT_AUTO_CAPTURE_SESSIONS
     ports:
       - target: 3000
         published: 61284
@@ -163,6 +172,8 @@ services:
       args:
         - RUBY_VERSION
         - APP_PATH
+    depends_on:
+      - mongo
     environment:
       - BUGSNAG_API_KEY
       - http_proxy
@@ -187,6 +198,8 @@ services:
       - BUGSNAG_SESSION_ENDPOINT
       - BUGSNAG_TIMEOUT
       - CALLBACK_INITIATOR
+      - SQL_ONLY_BREADCRUMBS
+      - USE_DEFAULT_AUTO_CAPTURE_SESSIONS
     ports:
       - target: 3000
         published: 61285

data/features/fixtures/rails3/app/app/controllers/breadcrumbs_controller.rb

@@ -0,0 +1,19 @@
+class BreadcrumbsController < ApplicationController
+  def handled
+    Bugsnag.notify("Request breadcrumb")
+    render json: {}
+  end
+
+  def sql_breadcrumb
+    User.where(:email => "foo").as_json
+    Bugsnag.notify("SQL breadcrumb")
+    render json: {}
+  end
+
+  def cache_read
+    Rails.cache.write('test', true)
+    Rails.cache.read('test')
+    Bugsnag.notify("Cache breadcrumb")
+    render json: {}
+  end
+end

data/features/fixtures/rails3/app/app/controllers/session_tracking_controller.rb

@@ -6,15 +6,19 @@ class SessionTrackingController < ActionController::Base
   end
 
   def initializer
-    Bugsnag.session_tracker.send_sessions()
+    Bugsnag.session_tracker.send_sessions
     render json: {}
   end
 
-  def after
-    Bugsnag.configure do |conf|
-      conf.auto_capture_sessions = true
-    end
-    Bugsnag.session_tracker.send_sessions()
+  def manual
+    Bugsnag.start_session
+    Bugsnag.session_tracker.send_sessions
+    render json: {}
+  end
+
+  def multi_sessions
+    (0...100).each { Bugsnag.start_session }
+    Bugsnag.session_tracker.send_sessions
     render json: {}
   end
 end

data/features/fixtures/rails3/app/config/initializers/bugsnag.rb

@@ -7,8 +7,14 @@ Bugsnag.configure do |config|
   config.auto_notify = ENV["BUGSNAG_AUTO_NOTIFY"] != "false"
   config.project_root = ENV["BUGSNAG_PROJECT_ROOT"] if ENV.include? "BUGSNAG_PROJECT_ROOT"
   config.ignore_classes << lambda { |ex| ex.class.to_s == ENV["BUGSNAG_IGNORE_CLASS"] } if ENV.include? "BUGSNAG_IGNORE_CLASS"
-  config.auto_capture_sessions = ENV["BUGSNAG_AUTO_CAPTURE_SESSIONS"] == "true"
+  config.auto_capture_sessions = ENV["BUGSNAG_AUTO_CAPTURE_SESSIONS"] == "true" unless ENV["USE_DEFAULT_AUTO_CAPTURE_SESSIONS"]
   config.release_stage = ENV["BUGSNAG_RELEASE_STAGE"] if ENV.include? "BUGSNAG_RELEASE_STAGE"
   config.send_code = ENV["BUGSNAG_SEND_CODE"] != "false"
   config.send_environment = ENV["BUGSNAG_SEND_ENVIRONMENT"] == "true"
-end
+
+  if ENV["SQL_ONLY_BREADCRUMBS"] == "true"
+    config.before_breadcrumb_callbacks << Proc.new do |breadcrumb|
+      breadcrumb.ignore! unless breadcrumb.meta_data[:event_name] == "sql.active_record" && breadcrumb.meta_data[:name] == "User Load"
+    end
+  end
+end

data/features/fixtures/rails3/app/config/routes.rb

@@ -14,5 +14,6 @@ App::Application.routes.draw do
   get "/send_code/(:action)", controller: 'send_code'
   get "/send_environment/(:action)", controller: 'send_environment'
   get "/warden/(:action)", controller: 'warden'
+  get "/breadcrumbs/(:action)", controller: 'breadcrumbs'
   get "/(:action)", controller: 'application'
 end

data/features/fixtures/rails4/app/Gemfile

@@ -39,4 +39,8 @@ end
 # Added at 2018-03-26 15:02:53 +0100 by amoinet:
 gem 'bugsnag', path: '/bugsnag'
 
-gem 'devise'
+gem 'devise'
+
+gem "mongoid", '~> 5.4.0'
+
+gem "nokogiri", "1.6.8"

data/features/fixtures/rails4/app/app/controllers/breadcrumbs_controller.rb

@@ -0,0 +1,26 @@
+class BreadcrumbsController < ApplicationController
+  def handled
+    Bugsnag.notify("Request breadcrumb")
+    render json: {}
+  end
+
+  def sql_breadcrumb
+    User.find_by(email: "foo")
+    Bugsnag.notify("SQL breadcrumb")
+    render json: {}
+  end
+
+  def active_job
+    Thread.new { NotifyJob.perform_later }.join
+    render json: {}
+  end
+
+  def cache_read
+    Thread.new {
+      Rails.cache.write('test', true)
+      Rails.cache.read('test')
+      Bugsnag.notify("Cache breadcrumb")
+    }.join
+    render json: {}
+  end
+end

data/features/fixtures/rails4/app/app/controllers/mongo_controller.rb

@@ -0,0 +1,23 @@
+class MongoController < ApplicationController
+
+  def success_crash
+    doc = MongoModel.create(string_field: "String")
+    doc.save
+    "Statement".prepnd("Failing")
+  end
+
+  def get_crash
+    MongoModel.where(string_field: true).as_json
+    MongoModel.any_of({string_field: true}, {numeric_field: 123}).as_json
+    "Statement".prepnd("Failing")
+  end
+
+  def failure_crash
+    begin
+      Mongoid::Clients.default.database.command(:bogus => 1)
+    rescue
+    end
+
+    "Statement".prepnd("Failing")
+  end
+end

data/features/fixtures/rails4/app/app/controllers/session_tracking_controller.rb

@@ -10,11 +10,15 @@ class SessionTrackingController < ActionController::Base
     render json: {}
   end
 
-  def after
-    Bugsnag.configure do |conf|
-      conf.auto_capture_sessions = true
-    end
-    Bugsnag.session_tracker.send_sessions()
+  def manual
+    Bugsnag.start_session
+    Bugsnag.session_tracker.send_sessions
+    render json: {}
+  end
+
+  def multi_sessions
+    (0...100).each { Bugsnag.start_session }
+    Bugsnag.session_tracker.send_sessions
     render json: {}
   end
 end

data/features/fixtures/rails4/app/app/jobs/application_job.rb

@@ -0,0 +1,2 @@
+class ApplicationJob < ActiveJob::Base
+end

data/features/fixtures/rails4/app/app/jobs/notify_job.rb

@@ -0,0 +1,5 @@
+class NotifyJob < ApplicationJob
+  def perform
+    Bugsnag.notify("Failed")
+  end
+end

data/features/fixtures/rails4/app/app/models/mongo_model.rb

@@ -0,0 +1,6 @@
+class MongoModel
+  include Mongoid::Document
+
+  field :string_field, type: String
+  field :numeric_field, type: Integer
+end

data/features/fixtures/rails4/app/config/initializers/bugsnag.rb

@@ -7,8 +7,14 @@ Bugsnag.configure do |config|
   config.auto_notify = ENV["BUGSNAG_AUTO_NOTIFY"] != "false"
   config.project_root = ENV["BUGSNAG_PROJECT_ROOT"] if ENV.include? "BUGSNAG_PROJECT_ROOT"
   config.ignore_classes << lambda { |ex| ex.class.to_s == ENV["BUGSNAG_IGNORE_CLASS"] } if ENV.include? "BUGSNAG_IGNORE_CLASS"
-  config.auto_capture_sessions = ENV["BUGSNAG_AUTO_CAPTURE_SESSIONS"] == "true"
+  config.auto_capture_sessions = ENV["BUGSNAG_AUTO_CAPTURE_SESSIONS"] == "true" unless ENV["USE_DEFAULT_AUTO_CAPTURE_SESSIONS"]
   config.release_stage = ENV["BUGSNAG_RELEASE_STAGE"] if ENV.include? "BUGSNAG_RELEASE_STAGE"
   config.send_code = ENV["BUGSNAG_SEND_CODE"] != "false"
   config.send_environment = ENV["BUGSNAG_SEND_ENVIRONMENT"] == "true"
+
+  if ENV["SQL_ONLY_BREADCRUMBS"] == "true"
+    config.before_breadcrumb_callbacks << Proc.new do |breadcrumb|
+      breadcrumb.ignore! unless breadcrumb.meta_data[:event_name] == "sql.active_record" && breadcrumb.meta_data[:name] == "User Load"
+    end
+  end
 end

data/features/fixtures/rails4/app/config/mongoid.yml

@@ -0,0 +1,22 @@
+development:
+  # Configure available database clients. (required)
+  clients:
+    # Defines the default client. (required)
+    default:
+      # Defines the name of the default database that Mongoid can connect to.
+      # (required).
+      database: rails4_development
+      # Provides the hosts the default client can connect to. Must be an array
+      # of host:port pairs. (required)
+      hosts:
+        - mongo:27017
+test:
+  clients:
+    default:
+      database: rails4_test
+      hosts:
+        - mongo:27017
+      options:
+        read:
+          mode: :primary
+        max_pool_size: 1

data/features/fixtures/rails4/app/config/routes.rb

@@ -16,4 +16,6 @@ App::Application.routes.draw do
   get "/send_code/(:action)", controller: 'send_code'
   get "/send_environment/(:action)", controller: 'send_environment'
   get "/devise/(:action)", controller: 'devise'
+  get "/breadcrumbs/(:action)", controller: 'breadcrumbs'
+  get "/mongo/(:action)", controller: 'mongo'
 end

data/features/fixtures/rails5/app/Gemfile

@@ -45,3 +45,7 @@ gem 'bugsnag', path: '/bugsnag'
 
 # Added at 2018-04-26 10:20:10 +0100 by amoinet:
 gem "clearance", "~> 1.16"
+
+gem "mongoid"
+
+gem "nokogiri", "1.6.8"

data/features/fixtures/rails5/app/app/controllers/breadcrumbs_controller.rb

@@ -0,0 +1,24 @@
+class BreadcrumbsController < ApplicationController
+  def handled
+    Bugsnag.notify("Request breadcrumb")
+    render json: {}
+  end
+
+  def sql_breadcrumb
+    User.find_by(email: "foo")
+    Bugsnag.notify("SQL breadcrumb")
+    render json: {}
+  end
+
+  def active_job
+    NotifyJob.perform_later
+    render json: {}
+  end
+
+  def cache_read
+    Rails.cache.write('test', true)
+    Rails.cache.read('test')
+    Bugsnag.notify("Cache breadcrumb")
+    render json: {}
+  end
+end

data/features/fixtures/rails5/app/app/controllers/mongo_controller.rb

@@ -0,0 +1,22 @@
+class MongoController < ApplicationController
+  def success_crash
+    doc = MongoModel.create(string_field: "String")
+    doc.save
+    "Statement".prepnd("Failing")
+  end
+
+  def get_crash
+    MongoModel.where(string_field: true).as_json
+    MongoModel.any_of({string_field: true}, {numeric_field: 123}).as_json
+    "Statement".prepnd("Failing")
+  end
+
+  def failure_crash
+    begin
+      Mongoid::Clients.default.database.command(:bogus => 1)
+    rescue
+    end
+
+    "Statement".prepnd("Failing")
+  end
+end

data/features/fixtures/rails5/app/app/controllers/session_tracking_controller.rb

@@ -6,11 +6,15 @@ class SessionTrackingController < ActionController::Base
     render json: {}
   end
 
-  def after
-    Bugsnag.configure do |conf|
-      conf.auto_capture_sessions = true
-    end
-    Bugsnag.session_tracker.send_sessions()
+  def manual
+    Bugsnag.start_session
+    Bugsnag.session_tracker.send_sessions
+    render json: {}
+  end
+
+  def multi_sessions
+    (0...100).each { Bugsnag.start_session }
+    Bugsnag.session_tracker.send_sessions
     render json: {}
   end
 end

data/features/fixtures/rails5/app/app/jobs/notify_job.rb

@@ -0,0 +1,5 @@
+class NotifyJob < ApplicationJob
+  def perform
+    Bugsnag.notify("Failed")
+  end
+end

data/features/fixtures/rails5/app/app/models/mongo_model.rb

@@ -0,0 +1,6 @@
+class MongoModel
+  include Mongoid::Document
+
+  field :string_field, type: String
+  field :numeric_field, type: Integer
+end