Breadcrumbs: Add Mongo integration

features/fixtures/docker-compose.yml

@@ -4,6 +4,9 @@ services:
   redis:
     image: redis
 
+  mongo:
+    image: mongo
+
   plain-ruby:
     build:
       context: plain
@@ -93,6 +96,8 @@ services:
       args:
         - RUBY_VERSION
         - APP_PATH
+    depends_on:
+      - mongo
     environment:
       - BUGSNAG_API_KEY
       - http_proxy
@@ -128,6 +133,8 @@ services:
       args:
         - RUBY_VERSION
         - APP_PATH
+    depends_on:
+      - mongo
     environment:
       - BUGSNAG_API_KEY
       - http_proxy
@@ -163,6 +170,8 @@ services:
       args:
         - RUBY_VERSION
         - APP_PATH
+    depends_on:
+      - mongo
     environment:
       - BUGSNAG_API_KEY
       - http_proxy

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

@@ -0,0 +1,23 @@
+class BreadcrumbsController < ActionController::Base
+  def initialize
+    @cache = ActiveSupport::Cache::MemoryStore.new
+  end
+
+  def handled
+    Bugsnag.notify("Request breadcrumb")
+    render json: {}
+  end
+
+  def sql_breadcrumb
+    User.take
+    Bugsnag.notify("SQL breadcrumb")
+    render json: {}
+  end
+
+  def cache_read
+    @cache.write('test', true)
+    @cache.read('test')
+    Bugsnag.notify("Cache breadcrumb")
+    render json: {}
+  end
+end

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

@@ -14,5 +14,6 @@
   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

features/fixtures/rails4/app/Gemfile

@@ -39,4 +39,6 @@ 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'

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

@@ -0,0 +1,28 @@
+class BreadcrumbsController < ActionController::Base
+  def initialize
+    @cache = ActiveSupport::Cache::MemoryStore.new
+  end
+
+  def handled
+    Bugsnag.notify("Request breadcrumb")
+    render json: {}
+  end
+
+  def sql_breadcrumb
+    User.take
+    Bugsnag.notify("SQL breadcrumb")
+    render json: {}
+  end
+
+  def active_job
+    ApplicationJob.perform_later
+    render json: {}
+  end
+
+  def cache_read
+    @cache.write('test', true)
+    @cache.read('test')
+    Bugsnag.notify("Cache breadcrumb")
+    render json: {}
+  end
+end

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

@@ -0,0 +1,17 @@
+class MongoController < ActionController
+
+  def success_crash
+    doc = MongoModel.create(string_field: "String")
+    doc.save
+    "Statement".prepnd("Failing")
+  end
+
+  def failure_crash
+    begin
+      Mongoid::Clients.default.database.command(:bogus => 1)
+    rescue
+    end
+
+    "Statement".prepnd("Failing")
+  end
+end

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

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

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

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

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:27018
+      options:
+        read:
+          mode: :primary
+        max_pool_size: 1

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

@@ -16,4 +16,6 @@
   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

features/fixtures/rails5/app/Gemfile

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

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

@@ -0,0 +1,35 @@
+class BreadcrumbsController < ActionController::Base
+  protect_from_forgery with: :exception
+
+  def initialize
+    @cache = ActiveSupport::Cache::MemoryStore.new
+  end
+
+  def handled
+    Bugsnag.notify("Request breadcrumb")
+    render json: {}
+  end
+
+  def sql_breadcrumb
+    User.take
+    Bugsnag.notify("SQL breadcrumb")
+    render json: {}
+  end
+
+  def active_job
+    ApplicationJob.perform_later
+    render json: {}
+  end
+
+  def cache_read
+    @cache.write('test', true)
+    @cache.read('test')
+    Bugsnag.notify("Cache breadcrumb")
+    render json: {}
+  end
+
+  def action_mailer
+    Bugsnag.notify("Mailer breadcrumb")
+    render json: {}
+  end
+end

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

@@ -0,0 +1,16 @@
+class MongoController < ActionController
+  def success_crash
+    doc = MongoModel.create(string_field: "String")
+    doc.save
+    "Statement".prepnd("Failing")
+  end
+
+  def failure_crash
+    begin
+      Mongoid::Clients.default.database.command(:bogus => 1)
+    rescue
+    end
+
+    "Statement".prepnd("Failing")
+  end
+end

features/fixtures/rails5/app/app/jobs/application_job.rb

@@ -1,2 +1,5 @@
 class ApplicationJob < ActiveJob::Base
+  def perform
+    Bugsnag.notify("Failed")
+  end
 end

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

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

features/fixtures/rails5/app/config/mongoid.yml

@@ -0,0 +1,23 @@
+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: rails5_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: rails5_test
+      hosts:
+        - mongo:27017
+      options:
+        read:
+          mode: :primary
+        max_pool_size: 1

features/fixtures/rails5/app/config/routes.rb

@@ -49,4 +49,12 @@
   get 'clearance/create', to: 'clearance#create'
   get 'clearance/unhandled', to: 'clearance#unhandled'
   get 'clearance/handled', to: 'clearance#handled'
+
+  get 'breadcrumbs/handled', to: 'breadcrumbs#handled'
+  get 'breadcrumbs/sql_breadcrumb', to: 'breadcrumbs#sql_breadcrumb'
+  get 'breadcrumbs/active_job', to: 'breadcrumbs#active_job'
+  get 'breadcrumbs/cache_read', to: 'breadcrumbs#cache_read'
+
+  get 'mongo/success_crash', to: 'mongo#success_crash'
+  get 'mongo/failure_crash', to: 'mongo#failure_crash'
 end

features/rails_features/breadcrumbs.feature

@@ -0,0 +1,106 @@
+Feature: Rails automatic breadcrumbs
+
+Background:
+  Given I set environment variable "BUGSNAG_API_KEY" to "a35a2a72bd230ac0aa0f52715bbdc6aa"
+  And I set environment variable "APP_PATH" to "/usr/src"
+  And I configure the bugsnag endpoint
+
+Scenario Outline: Request breadcrumb
+  Given I set environment variable "RUBY_VERSION" to "<ruby_version>"
+  And I start the service "rails<rails_version>"
+  And I wait for the app to respond on port "6128<rails_version>"
+  When I navigate to the route "/breadcrumbs/handled" on port "6128<rails_version>"
+  Then I should receive a request
+  And the request is a valid for the error reporting API
+  And the request used the "Ruby Bugsnag Notifier" notifier
+  And the request contained the api key "a35a2a72bd230ac0aa0f52715bbdc6aa"
+  And the event has a "request" breadcrumb named "Controller started processing"
+  And the event "breadcrumbs.0.timestamp" is a timestamp
+  And the event "breadcrumbs.0.metaData.controller" equals "BreadcrumbsController"
+  And the event "breadcrumbs.0.metaData.action" equals "handled"
+  And the event "breadcrumbs.0.metaData.method" equals "GET"
+  And the event "breadcrumbs.0.metaData.path" equals "/breadcrumbs/handled"
+  And the event "breadcrumbs.0.metaData.event_name" equals "start_processing.action_controller"
+
+  Examples:
+    | ruby_version | rails_version |
+    | 2.0          | 3             |
+    | 2.1          | 3             |
+    | 2.2          | 3             |
+    | 2.2          | 4             |
+    | 2.2          | 5             |
+    | 2.3          | 3             |
+    | 2.3          | 4             |
+    | 2.3          | 5             |
+    | 2.4          | 3             |
+    | 2.4          | 5             |
+    | 2.5          | 3             |
+    | 2.5          | 5             |
+
+Scenario Outline: SQL Breadcrumb
+  Given I set environment variable "RUBY_VERSION" to "<ruby_version>"
+  And I start the service "rails<rails_version>"
+  And I wait for the app to respond on port "6128<rails_version>"
+  When I navigate to the route "/breadcrumbs/sql_breadcrumb" on port "6128<rails_version>"
+  Then I should receive a request
+  And the request is a valid for the error reporting API
+  And the request used the "Ruby Bugsnag Notifier" notifier
+  And the request contained the api key "a35a2a72bd230ac0aa0f52715bbdc6aa"
+  And the event has a "process" breadcrumb named "ActiveRecord SQL query"
+
+  Examples:
+    | ruby_version | rails_version |
+    | 2.0          | 3             |
+    | 2.1          | 3             |
+    | 2.2          | 3             |
+    | 2.2          | 4             |
+    | 2.2          | 5             |
+    | 2.3          | 3             |
+    | 2.3          | 4             |
+    | 2.3          | 5             |
+    | 2.4          | 3             |
+    | 2.4          | 5             |
+    | 2.5          | 3             |
+    | 2.5          | 5             |
+
+Scenario Outline: Active job breadcrumb
+  Given I set environment variable "RUBY_VERSION" to "<ruby_version>"
+  And I start the service "rails<rails_version>"
+  And I wait for the app to respond on port "6128<rails_version>"
+  When I navigate to the route "/breadcrumbs/active_job" on port "6128<rails_version>"
+  Then I should receive a request
+  And the request is a valid for the error reporting API
+  And the request used the "Ruby Bugsnag Notifier" notifier
+  And the request contained the api key "a35a2a72bd230ac0aa0f52715bbdc6aa"
+  And the event has a "process" breadcrumb named "Start perform ActiveJob"
+  And the event "breadcrumbs.0.timestamp" is a timestamp
+  And the event "breadcrumbs.0.metaData.event_name" equals "perform_start.active_job"
+
+  Examples:
+    | ruby_version | rails_version |
+    | 2.2          | 4             |
+    | 2.2          | 5             |
+    | 2.3          | 4             |
+    | 2.3          | 5             |
+    | 2.4          | 5             |
+    | 2.5          | 5             |
+
+Scenario Outline: Cache read
+  Given I set environment variable "RUBY_VERSION" to "<ruby_version>"
+  And I start the service "rails<rails_version>"
+  And I wait for the app to respond on port "6128<rails_version>"
+  When I navigate to the route "/breadcrumbs/cache_read" on port "6128<rails_version>"
+  Then I should receive a request
+  And the request is a valid for the error reporting API
+  And the request used the "Ruby Bugsnag Notifier" notifier
+  And the request contained the api key "a35a2a72bd230ac0aa0f52715bbdc6aa"
+  And the event has a "process" breadcrumb named "Read cache"
+
+  Examples:
+    | ruby_version | rails_version |
+    | 2.2          | 4             |
+    | 2.2          | 5             |
+    | 2.3          | 4             |
+    | 2.3          | 5             |
+    | 2.4          | 5             |
+    | 2.5          | 5             |