bugsnag 6.8.0 → 6.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f8882dc5d19d25ae75a753fa792ea78b11a560d4a243476da2c83d1d4a305398
-  data.tar.gz: 2ea9b4a31d64680adb7da9bc9d263bdae884bd73809104afb9f95e191b8f745f
+  metadata.gz: 605acdc244d830e20748ce790d64b0f74b1fea4c33f7ba65df14d51e632ed035
+  data.tar.gz: eda01aab79404d506323aca686fdcaa808a285162c15e860e27d4ba61ca845b2
 SHA512:
-  metadata.gz: 7eafa6a7c6fad28e286a108b0886459197a7d835a705adb27982d50c66a68c45309b18ca068a4ee7d8c7c61e9df1e80de7f77c5cd548793a5349faf6a155e7dd
-  data.tar.gz: 65d479960f64808cc316a3a95c143cdb8e349e0a7b2ec2b91bd3ad2a9a4f772731e00eb0074b5802f15138e365d3cc99ef640f73c6566ba8e7c0dce32d259f41
+  metadata.gz: 0ab2e74a4cd3d7add6be58a22c2eefc366d6ee97791bf8a81c4cba32e847dd4bf6397704322264861d64c745a1c0b52aab2adc4964814ccc33e943d153776066
+  data.tar.gz: 2941712b666e84a6c93dcbaa5ddb38d433d57138af6f06eac7ba6500e3d5a6cce989e1560a9780b6a222cf41b2b5d7c30777381060458ed5632ed95b7a5e5c6c

data/.rubocop_todo.yml

@@ -244,6 +244,7 @@ Lint/RescueException:
     - 'lib/bugsnag/integrations/rake.rb'
     - 'lib/bugsnag/integrations/shoryuken.rb'
     - 'lib/bugsnag/integrations/sidekiq.rb'
+    - 'lib/bugsnag/integrations/delayed_job.rb'
 
 # Offense count: 6
 # Cop supports --auto-correct.

data/.travis.yml

@@ -26,12 +26,12 @@ jobs:
     - BUNDLE_VERSION=1.12.0
     - GEMSETS=test
   - stage: test
-    rvm: 2.0.0
+    rvm: 2.0
     env:
     - BUNDLE_VERSION=1.12.0
     - GEMSETS=test
   - stage: test
-    rvm: 2.1.
+    rvm: 2.1
     env:
     - BUNDLE_VERSION=1.12.0
     - GEMSETS=test
@@ -39,22 +39,27 @@ jobs:
     env:
     - BUNDLE_VERSION=1.12.0
     - GEMSETS="test sidekiq"
-    rvm: 2.2.4
+    rvm: 2.2
   - stage: test
     env:
     - BUNDLE_VERSION=1.12.0
-    - GEMSETS="test sidekiq coverage"
-    rvm: 2.3.0
+    - GEMSETS="test sidekiq"
+    rvm: 2.3
   - stage: test
     env:
     - BUNDLE_VERSION=1.12.0
     - GEMSETS="test sidekiq"
-    rvm: 2.4.1
+    rvm: 2.4
+  - stage: test
+    env:
+    - BUNDLE_VERSION=1.12.0
+    - GEMSETS="test sidekiq coverage"
+    rvm: 2.5
   - stage: test
     env:
     - BUNDLE_VERSION=1.12.0
     - GEMSETS="test rubocop"
-    rvm: 2.4.1
+    rvm: 2.5
     script: bundle exec ./bin/rubocop lib/
   # - stage: test
   #   addons:

data/CHANGELOG.md

@@ -1,6 +1,18 @@
 Changelog
 =========
 
+## 6.9.0 (12 Nov 2018)
+
+### Enhancements
+
+* Ensure the correct error handler is used in newer versions of Sidekiq
+  | [#434](https://github.com/bugsnag/bugsnag-ruby/pull/434)
+
+* Rewrite Delayed::Job integration to fix potential issues and add more
+  collected data
+  | [#492](https://github.com/bugsnag/bugsnag-ruby/pull/492)
+  | [Simon Maynard](https://github.com/snmaynard)
+
 ## 6.8.0 (11 Jul 2018)
 
 This release includes general performance improvements to payload trimming and

data/README.md

@@ -7,7 +7,7 @@ The Bugsnag exception reporter for Ruby gives you instant notification of except
 ## Features
 
 * Automatically report unhandled exceptions and crashes
-* Report handled exceptions 
+* Report handled exceptions
 * Attach user information to determine how many people are affected by a crash
 * Send customized diagnostic data
 

data/VERSION

@@ -1 +1 @@
-6.8.0
+6.9.0

data/features/.gitignore

@@ -0,0 +1 @@
+temp-bugsnag-lib

data/features/delayed_job.feature

@@ -0,0 +1,53 @@
+Feature: Bugsnag detects errors in Delayed job workers
+
+Background:
+  Given I set environment variable "BUGSNAG_API_KEY" to "a35a2a72bd230ac0aa0f52715bbdc6aa"
+  And I set environment variable "MAZE_API_KEY" to "a35a2a72bd230ac0aa0f52715bbdc6aa"
+  And I configure the bugsnag endpoint
+
+Scenario: An unhandled RuntimeError sends a report with arguments
+  Given I set environment variable "RUBY_VERSION" to "2.5"
+  And I start the service "delayed_job"
+  And I run the command "bundle exec rails runner 'TestModel.delay.fail_with_args(\"Test\")'" on the service "delayed_job"
+  And I wait for 5 seconds
+  Then I should receive a request
+  And the request used the Ruby notifier
+  And the request used payload v4 headers
+  And the request contained the api key "a35a2a72bd230ac0aa0f52715bbdc6aa"
+  And the event "unhandled" is true
+  And the event "severity" is "error"
+  And the event "context" is "TestModel.fail_with_args"
+  And the event "severityReason.type" is "unhandledExceptionMiddleware"
+  And the event "severityReason.attributes.framework" is "DelayedJob"
+  And the exception "errorClass" equals "RuntimeError"
+  And the event "metaData.job.class" equals "Delayed::Backend::ActiveRecord::Job"
+  And the event "metaData.job.id" is not null
+  And the event "metaData.job.attempt" equals 1
+  And the event "metaData.job.max_attempts" equals 1
+  And the event "metaData.job.payload.display_name" equals "TestModel.fail_with_args"
+  And the event "metaData.job.payload.method_name" equals "fail_with_args"
+  And the payload field "events.0.metaData.job.payload.args" is an array with 1 element
+  And the payload field "events.0.metaData.job.payload.args.0" equals "Test"
+
+Scenario: A handled exception sends a report
+  Given I set environment variable "RUBY_VERSION" to "2.5"
+  And I start the service "delayed_job"
+  And I run the command "bundle exec rails runner 'TestModel.delay.notify_with_args(\"Test\")'" on the service "delayed_job"
+  And I wait for 5 seconds
+  Then I should receive a request
+  And the request used the Ruby notifier
+  And the request used payload v4 headers
+  And the request contained the api key "a35a2a72bd230ac0aa0f52715bbdc6aa"
+  And the event "unhandled" is false
+  And the event "severity" is "warning"
+  And the event "context" is "TestModel.notify_with_args"
+  And the event "severityReason.type" is "handledException"
+  And the exception "errorClass" equals "RuntimeError"
+  And the event "metaData.job.class" equals "Delayed::Backend::ActiveRecord::Job"
+  And the event "metaData.job.id" is not null
+  And the event "metaData.job.attempt" equals 1
+  And the event "metaData.job.max_attempts" equals 1
+  And the event "metaData.job.payload.display_name" equals "TestModel.notify_with_args"
+  And the event "metaData.job.payload.method_name" equals "notify_with_args"
+  And the payload field "events.0.metaData.job.payload.args" is an array with 1 element
+  And the payload field "events.0.metaData.job.payload.args.0" equals "Test"

data/features/fixtures/delayed_job/Dockerfile

@@ -1,12 +1,17 @@
 ARG ruby_version
 FROM ruby:$ruby_version
 
-RUN mkdir -p /usr/src/app
-WORKDIR /usr/src/app
+WORKDIR /bugsnag
+COPY temp-bugsnag-lib ./
 
-COPY Gemfile /usr/src/app/
+WORKDIR /usr/src/app
+COPY app/Gemfile /usr/src/app/
 RUN bundle install
 
-COPY . /usr/src/app
+COPY app/ /usr/src/app
+
+RUN bundle exec rake rails:update:bin
+RUN bundle exec bin/rails generate delayed_job:active_record
+RUN bundle exec rake db:migrate
 
-CMD ["bundle", "exec", "rails", "s", "-b", "0.0.0.0"]
+CMD ["bundle", "exec", "rake", "jobs:work"]

data/features/fixtures/delayed_job/app/.gitignore

@@ -0,0 +1,21 @@
+# See https://help.github.com/articles/ignoring-files for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile '~/.gitignore_global'
+
+# Ignore bundler config.
+/.bundle
+
+# Ignore the default SQLite database.
+/db/*.sqlite3
+/db/*.sqlite3-journal
+
+# Ignore all logfiles and tempfiles.
+/log/*
+/tmp/*
+!/log/.keep
+!/tmp/.keep
+
+# Ignore Byebug command history file.
+.byebug_history

data/features/fixtures/delayed_job/app/Gemfile

@@ -0,0 +1,57 @@
+source 'https://rubygems.org'
+
+git_source(:github) do |repo_name|
+  repo_name = "#{repo_name}/#{repo_name}" unless repo_name.include?("/")
+  "https://github.com/#{repo_name}.git"
+end
+
+gem 'bugsnag', path: '/bugsnag'
+gem 'delayed_job'
+gem 'delayed_job_active_record'
+gem 'therubyracer'
+
+# Bundle edge Rails instead: gem 'rails', github: 'rails/rails'
+gem 'rails', '~> 5.0.7'
+# Use sqlite3 as the database for Active Record
+gem 'sqlite3'
+# Use Puma as the app server
+gem 'puma', '~> 3.0'
+# Use SCSS for stylesheets
+gem 'sass-rails', '~> 5.0'
+# Use Uglifier as compressor for JavaScript assets
+gem 'uglifier', '>= 1.3.0'
+# Use CoffeeScript for .coffee assets and views
+gem 'coffee-rails', '~> 4.2'
+# See https://github.com/rails/execjs#readme for more supported runtimes
+# gem 'therubyracer', platforms: :ruby
+
+# Use jquery as the JavaScript library
+gem 'jquery-rails'
+# Turbolinks makes navigating your web application faster. Read more: https://github.com/turbolinks/turbolinks
+gem 'turbolinks', '~> 5'
+# Build JSON APIs with ease. Read more: https://github.com/rails/jbuilder
+gem 'jbuilder', '~> 2.5'
+# Use Redis adapter to run Action Cable in production
+# gem 'redis', '~> 3.0'
+# Use ActiveModel has_secure_password
+# gem 'bcrypt', '~> 3.1.7'
+
+# Use Capistrano for deployment
+# gem 'capistrano-rails', group: :development
+
+group :development, :test do
+  # Call 'byebug' anywhere in the code to stop execution and get a debugger console
+  gem 'byebug', platform: :mri
+end
+
+group :development do
+  # Access an IRB console on exception pages or by using <%= console %> anywhere in the code.
+  gem 'web-console', '>= 3.3.0'
+  gem 'listen', '~> 3.0.5'
+  # Spring speeds up development by keeping your application running in the background. Read more: https://github.com/rails/spring
+  gem 'spring'
+  gem 'spring-watcher-listen', '~> 2.0.0'
+end
+
+# Windows does not include zoneinfo files, so bundle the tzinfo-data gem
+gem 'tzinfo-data', platforms: [:mingw, :mswin, :x64_mingw, :jruby]

data/features/fixtures/delayed_job/app/README.md

@@ -0,0 +1,24 @@
+# README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...

data/features/fixtures/delayed_job/app/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require_relative 'config/application'
+
+Rails.application.load_tasks

data/features/fixtures/delayed_job/app/app/assets/config/manifest.js

@@ -0,0 +1,3 @@
+//= link_tree ../images
+//= link_directory ../javascripts .js
+//= link_directory ../stylesheets .css

data/features/fixtures/delayed_job/app/app/assets/javascripts/application.js

@@ -0,0 +1,16 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file. JavaScript code in this file should be added after the last require_* statement.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require jquery
+//= require jquery_ujs
+//= require turbolinks
+//= require_tree .

data/features/fixtures/delayed_job/app/app/assets/javascripts/cable.js

@@ -0,0 +1,13 @@
+// Action Cable provides the framework to deal with WebSockets in Rails.
+// You can generate new channels where WebSocket features live using the rails generate channel command.
+//
+//= require action_cable
+//= require_self
+//= require_tree ./channels
+
+(function() {
+  this.App || (this.App = {});
+
+  App.cable = ActionCable.createConsumer();
+
+}).call(this);

data/features/fixtures/delayed_job/app/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/features/fixtures/delayed_job/app/app/channels/application_cable/channel.rb

@@ -0,0 +1,4 @@
+module ApplicationCable
+  class Channel < ActionCable::Channel::Base
+  end
+end

data/features/fixtures/delayed_job/app/app/channels/application_cable/connection.rb

@@ -0,0 +1,4 @@
+module ApplicationCable
+  class Connection < ActionCable::Connection::Base
+  end
+end

data/features/fixtures/delayed_job/app/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery with: :exception
+end

data/features/fixtures/delayed_job/app/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

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

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

data/features/fixtures/delayed_job/app/app/mailers/application_mailer.rb

@@ -0,0 +1,4 @@
+class ApplicationMailer < ActionMailer::Base
+  default from: 'from@example.com'
+  layout 'mailer'
+end

data/features/fixtures/delayed_job/app/app/models/application_record.rb

@@ -0,0 +1,3 @@
+class ApplicationRecord < ActiveRecord::Base
+  self.abstract_class = true
+end

data/features/fixtures/delayed_job/app/app/models/test_model.rb

@@ -0,0 +1,10 @@
+class TestModel < ApplicationRecord
+
+  def self.fail_with_args(a)
+    raise "uh oh"
+  end
+
+  def self.notify_with_args(a)
+    Bugsnag.notify(RuntimeError.new("Handled exception"))
+  end
+end

data/features/fixtures/delayed_job/app/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>App</title>
+    <%= csrf_meta_tags %>
+
+    <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track': 'reload' %>
+    <%= javascript_include_tag 'application', 'data-turbolinks-track': 'reload' %>
+  </head>
+
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/features/fixtures/delayed_job/app/app/views/layouts/mailer.html.erb

@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    <style>
+      /* Email styles need to be inline */
+    </style>
+  </head>
+
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/features/fixtures/delayed_job/app/app/views/layouts/mailer.text.erb

@@ -0,0 +1 @@
+<%= yield %>

data/features/fixtures/delayed_job/app/config.ru

@@ -0,0 +1,5 @@
+# This file is used by Rack-based servers to start the application.
+
+require_relative 'config/environment'
+
+run Rails.application