bugsnag 6.8.0 → 6.9.0

data/features/support/env.rb

@@ -18,6 +18,22 @@ def output_logs
   end
 end
 
+def install_fixture_gems
+  gem_dir = File.expand_path('../../../', __FILE__)
+  Dir.chdir(gem_dir) do
+    `rm bugsnag-*.gem` unless Dir.glob('bugsnag-*.gem').empty?
+    `gem build bugsnag.gemspec`
+    Dir.entries('features/fixtures').reject { |entry| ['.', '..'].include?(entry) }.each do |entry|
+      target_dir = "features/fixtures/#{entry}"
+      if File.directory?(target_dir)
+        `cp bugsnag-*.gem #{target_dir}`
+        `gem unpack #{target_dir}/bugsnag-*.gem --target #{target_dir}/temp-bugsnag-lib`
+      end
+    end
+    `rm bugsnag-*.gem`
+  end
+end
+
 def current_ip
   if OS.mac?
     'host.docker.internal'
@@ -27,3 +43,5 @@ def current_ip
     ip_list.captures.first
   end
 end
+
+install_fixture_gems

data/lib/bugsnag.rb

@@ -27,6 +27,7 @@ require "bugsnag/middleware/mailman"
 require "bugsnag/middleware/rake"
 require "bugsnag/middleware/callbacks"
 require "bugsnag/middleware/classify_error"
+require "bugsnag/middleware/delayed_job"
 
 module Bugsnag
   LOCK = Mutex.new

data/lib/bugsnag/integrations/delayed_job.rb

@@ -5,92 +5,35 @@ unless defined?(Delayed::Plugin)
   raise LoadError, "bugsnag requires delayed_job > 3.x"
 end
 
-unless defined? Delayed::Plugins::Bugsnag
-  module Delayed
-    module Plugins
-      class Bugsnag < Plugin
-
-        FRAMEWORK_ATTRIBUTES = {
-          :framework => "DelayedJob"
-        }
-
-        module Notify
-          def error(job, error)
-            overrides = {
-              :job => {
-                :class => job.class.name,
-                :id => job.id,
-              },
-              :severity_reason => {
-                :type => ::Bugsnag::Report::UNHANDLED_EXCEPTION_MIDDLEWARE,
-                :attributes => FRAMEWORK_ATTRIBUTES,
-              },
-            }
-            if job.respond_to?(:queue) && (queue = job.queue)
-              overrides[:job][:queue] = queue
-            end
-            if job.respond_to?(:attempts)
-              max_attempts = (job.respond_to?(:max_attempts) && job.max_attempts) || Delayed::Worker.max_attempts
-              overrides[:job][:attempts] = "#{job.attempts + 1} / #{max_attempts}"
-              # +1 as "attempts" is zero-based and does not include the current failed attempt
-            end
-            if payload = job.payload_object
-              p = {
-                :class => payload.class.name,
-              }
-              p[:id]           = payload.id           if payload.respond_to?(:id)
-              p[:display_name] = payload.display_name if payload.respond_to?(:display_name)
-              p[:method_name]  = payload.method_name  if payload.respond_to?(:method_name)
-
-              if payload.respond_to?(:args)
-                p[:args] = payload.args
-              elsif payload.respond_to?(:to_h)
-                p[:args] = payload.to_h
-              end
-
-              if payload.is_a?(::Delayed::PerformableMethod) && (object = payload.object)
-                p[:object] = {
-                  :class => object.class.name,
-                }
-                p[:object][:id] = object.id if object.respond_to?(:id)
-              end
-              add_active_job_details(p, payload)
-              overrides[:job][:payload] = p
-            end
-
-            ::Bugsnag.notify(error, true) do |report|
+::Bugsnag.configuration.internal_middleware.use(::Bugsnag::Middleware::DelayedJob)
+
+module Delayed
+  module Plugins
+    class Bugsnag < ::Delayed::Plugin
+      callbacks do |lifecycle|
+        lifecycle.around(:invoke_job) do |job, *args, &block|
+          begin
+            ::Bugsnag.configuration.app_type = 'delayed_job'
+            ::Bugsnag.configuration.set_request_data(:delayed_job, job)
+            block.call(job, *args)
+          rescue Exception => exception
+            ::Bugsnag.notify(exception, true) do |report|
               report.severity = "error"
               report.severity_reason = {
                 :type => ::Bugsnag::Report::UNHANDLED_EXCEPTION_MIDDLEWARE,
-                :attributes => FRAMEWORK_ATTRIBUTES
+                :attributes => {
+                  :framework => "DelayedJob"
+                }
               }
-              report.meta_data.merge! overrides
-            end
-
-            super if defined?(super)
-          end
-
-          def add_active_job_details(p, payload)
-            if payload.respond_to?(:job_data) && payload.job_data.respond_to?(:[])
-              [:job_class, :arguments, :queue_name, :job_id].each do |key|
-                if (value = payload.job_data[key.to_s])
-                  p[key] = value
-                end
-              end
             end
-          end
-        end
-
-        callbacks do |lifecycle|
-          lifecycle.before(:invoke_job) do |job|
-            payload = job.payload_object
-            payload = payload.object if payload.is_a? Delayed::PerformableMethod
-            payload.extend Notify
+            raise exception
+          ensure
+            ::Bugsnag.configuration.clear_request_data
           end
         end
       end
     end
   end
-
-  Delayed::Worker.plugins << Delayed::Plugins::Bugsnag
 end
+
+Delayed::Worker.plugins << Delayed::Plugins::Bugsnag

data/lib/bugsnag/integrations/sidekiq.rb

@@ -5,9 +5,11 @@ module Bugsnag
   # Extracts and attaches Sidekiq job and queue information to an error report
   class Sidekiq
 
-    FRAMEWORK_ATTRIBUTES = {
-      :framework => "Sidekiq"
-    }
+    unless const_defined?(:FRAMEWORK_ATTRIBUTES)
+      FRAMEWORK_ATTRIBUTES = {
+        :framework => "Sidekiq"
+      }
+    end
 
     def initialize
       Bugsnag.configuration.internal_middleware.use(Bugsnag::Middleware::Sidekiq)
@@ -19,31 +21,44 @@ module Bugsnag
       begin
         # store msg/queue in thread local state to be read by Bugsnag::Middleware::Sidekiq
         Bugsnag.configuration.set_request_data :sidekiq, { :msg => msg, :queue => queue }
-
         yield
       rescue Exception => ex
-        raise ex if [Interrupt, SystemExit, SignalException].include? ex.class
-        Bugsnag.notify(ex, true) do |report|
-          report.severity = "error"
-          report.severity_reason = {
-            :type => Bugsnag::Report::UNHANDLED_EXCEPTION_MIDDLEWARE,
-            :attributes => FRAMEWORK_ATTRIBUTES
-          }
-        end
+        self.class.notify(ex) unless self.class.sidekiq_supports_error_handlers
         raise
       ensure
         Bugsnag.configuration.clear_request_data
       end
     end
+
+    def self.notify(exception)
+      return if [Interrupt, SystemExit, SignalException].include? exception.class
+      Bugsnag.notify(exception, true) do |report|
+        report.severity = "error"
+        report.severity_reason = {
+          :type => Bugsnag::Report::UNHANDLED_EXCEPTION_MIDDLEWARE,
+          :attributes => FRAMEWORK_ATTRIBUTES
+        }
+      end
+    end
+
+    def self.sidekiq_supports_error_handlers
+      Gem::Version.new(::Sidekiq::VERSION) >= Gem::Version.new('3.0.0')
+    end
+
+    def self.configure_server(server)
+      if Bugsnag::Sidekiq.sidekiq_supports_error_handlers
+        server.error_handlers << proc do |ex, _context|
+          Bugsnag::Sidekiq.notify(ex)
+        end
+      end
+
+      server.server_middleware do |chain|
+        chain.add ::Bugsnag::Sidekiq
+      end
+    end
   end
 end
 
 ::Sidekiq.configure_server do |config|
-  config.server_middleware do |chain|
-    if Gem::Version.new(Sidekiq::VERSION) >= Gem::Version.new('3.3.0')
-      chain.prepend ::Bugsnag::Sidekiq
-    else
-      chain.add ::Bugsnag::Sidekiq
-    end
-  end
+  Bugsnag::Sidekiq.configure_server(config)
 end

data/lib/bugsnag/middleware/delayed_job.rb

@@ -0,0 +1,73 @@
+module Bugsnag::Middleware
+  ##
+  # Attaches delayed_job information to an error report
+  class DelayedJob
+    def initialize(bugsnag)
+      @bugsnag = bugsnag
+    end
+
+    def call(report)
+      job = report.request_data[:delayed_job]
+      if job
+        job_data = {
+          :class => job.class.name,
+          :id => job.id
+        }
+        job_data[:priority] = job.priority if job.respond_to?(:priority)
+        job_data[:run_at] = job.run_at if job.respond_to?(:run_at)
+        job_data[:locked_at] = job.locked_at if job.respond_to?(:locked_at)
+        job_data[:locked_by] = job.locked_by if job.respond_to?(:locked_by)
+        job_data[:created_at] = job.created_at if job.respond_to?(:created_at)
+        job_data[:queue] = job.queue if job.respond_to?(:queue)
+
+        if job.respond_to?(:payload_object)
+          job_data[:active_job] = job.payload_object.job_data if job.payload_object.respond_to?(:job_data)
+          payload_data = construct_job_payload(job.payload_object)
+          report.context = payload_data[:display_name] if payload_data.include?(:display_name)
+          job_data[:payload] = payload_data
+        end
+
+        if job.respond_to?(:attempts)
+          # +1 as "attempts" is zero-based and does not include the current failed attempt
+          job_data[:attempt] = job.attempts + 1
+          job_data[:max_attempts] = (job.respond_to?(:max_attempts) && job.max_attempts) || Delayed::Worker.max_attempts
+        end
+
+        report.add_tab(:job, job_data)
+      end
+      @bugsnag.call(report)
+    end
+
+    def construct_job_payload(payload)
+      data = {
+        :class => payload.class.name
+      }
+      data[:id]           = payload.id           if payload.respond_to?(:id)
+      data[:display_name] = payload.display_name if payload.respond_to?(:display_name)
+      data[:method_name]  = payload.method_name  if payload.respond_to?(:method_name)
+
+      if payload.respond_to?(:args)
+        data[:args] = payload.args
+      elsif payload.respond_to?(:to_h)
+        data[:args] = payload.to_h
+      elsif payload.respond_to?(:instance_values)
+        data[:args] = payload.instance_values
+      end
+
+      if payload.is_a?(::Delayed::PerformableMethod) && (object = payload.object)
+        data[:object] = {
+          :class => object.class.name
+        }
+        data[:object][:id] = object.id if object.respond_to?(:id)
+      end
+      if payload.respond_to?(:job_data) && payload.job_data.respond_to?(:[])
+        [:job_class, :arguments, :queue_name, :job_id].each do |key|
+          if (value = payload.job_data[key.to_s])
+            data[key] = value
+          end
+        end
+      end
+      data
+    end
+  end
+end

data/spec/integrations/sidekiq_spec.rb

@@ -9,26 +9,61 @@ class FailingWorker
 end
 
 describe Bugsnag::Sidekiq do
-  before do
-    Sidekiq::Testing.inline!
-    Sidekiq::Testing.server_middleware do |chain|
-      chain.add Bugsnag::Sidekiq
+  # Integration testing v3 is handled by maze as sidekiq doesnt
+  # support error_handlers in testing mode
+  context "integration tests in v2" do
+    before do
+      Sidekiq::Testing.inline!
+      stub_const('Sidekiq::VERSION', '2.0.0')
+      Sidekiq::Testing.server_middleware do |chain|
+        chain.add ::Bugsnag::Sidekiq
+      end
+    end
+
+    it "works" do
+      begin
+        FailingWorker.perform_async(-0)
+        fail("shouldn't be here")
+      rescue
+      end
+
+      expect(Bugsnag).to have_sent_notification {|payload, headers|
+        event = get_event_from_payload(payload)
+        expect(event["metaData"]["sidekiq"]["msg"]["class"]).to eq("FailingWorker")
+        expect(event["metaData"]["sidekiq"]["msg"]["args"]).to eq([-0])
+        expect(event["metaData"]["sidekiq"]["msg"]["queue"]).to eq("default")
+        expect(event["severity"]).to eq("error")
+      }
     end
   end
 
-  it "works" do
-    begin
-      FailingWorker.perform_async(-0)
-      fail("shouldn't be here")
-    rescue
+  context "initializing the integrations" do
+    it "works in v2" do
+      config = double
+      expect(::Sidekiq).to receive(:configure_server).and_yield(config)
+      stub_const('Sidekiq::VERSION', '2.0.0')
+
+      chain = double
+      expect(config).to receive(:server_middleware).and_yield(chain)
+      expect(chain).to receive(:add).with(::Bugsnag::Sidekiq)
+
+      load './lib/bugsnag/integrations/sidekiq.rb'
     end
 
-    expect(Bugsnag).to have_sent_notification {|payload, headers|
-      event = get_event_from_payload(payload)
-      expect(event["metaData"]["sidekiq"]["msg"]["class"]).to eq("FailingWorker")
-      expect(event["metaData"]["sidekiq"]["msg"]["args"]).to eq([-0])
-      expect(event["metaData"]["sidekiq"]["msg"]["queue"]).to eq("default")
-      expect(event["severity"]).to eq("error")
-    }
+    it "works in v3" do
+      config = double
+      expect(::Sidekiq).to receive(:configure_server).and_yield(config)
+      stub_const('Sidekiq::VERSION', '3.0.0')
+
+      error_handlers = []
+      expect(config).to receive(:error_handlers).and_return(error_handlers)
+
+      chain = double
+      expect(config).to receive(:server_middleware).and_yield(chain)
+      expect(chain).to receive(:add).with(::Bugsnag::Sidekiq)
+
+      load './lib/bugsnag/integrations/sidekiq.rb'
+      expect(error_handlers.size).to eq(1)
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bugsnag
 version: !ruby/object:Gem::Version
-  version: 6.8.0
+  version: 6.9.0
 platform: ruby
 authors:
 - James Smith
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-11 00:00:00.000000000 Z
+date: 2018-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -49,9 +49,83 @@ files:
 - UPGRADING.md
 - VERSION
 - bugsnag.gemspec
-- features/fixtures/delayed_job/.dockerignore
+- features/.gitignore
+- features/delayed_job.feature
 - features/fixtures/delayed_job/Dockerfile
-- features/fixtures/delayed_job/Gemfile
+- features/fixtures/delayed_job/app/.gitignore
+- features/fixtures/delayed_job/app/Gemfile
+- features/fixtures/delayed_job/app/README.md
+- features/fixtures/delayed_job/app/Rakefile
+- features/fixtures/delayed_job/app/app/assets/config/manifest.js
+- features/fixtures/delayed_job/app/app/assets/images/.keep
+- features/fixtures/delayed_job/app/app/assets/javascripts/application.js
+- features/fixtures/delayed_job/app/app/assets/javascripts/cable.js
+- features/fixtures/delayed_job/app/app/assets/javascripts/channels/.keep
+- features/fixtures/delayed_job/app/app/assets/stylesheets/application.css
+- features/fixtures/delayed_job/app/app/channels/application_cable/channel.rb
+- features/fixtures/delayed_job/app/app/channels/application_cable/connection.rb
+- features/fixtures/delayed_job/app/app/controllers/application_controller.rb
+- features/fixtures/delayed_job/app/app/controllers/concerns/.keep
+- features/fixtures/delayed_job/app/app/helpers/application_helper.rb
+- features/fixtures/delayed_job/app/app/jobs/application_job.rb
+- features/fixtures/delayed_job/app/app/mailers/application_mailer.rb
+- features/fixtures/delayed_job/app/app/models/application_record.rb
+- features/fixtures/delayed_job/app/app/models/concerns/.keep
+- features/fixtures/delayed_job/app/app/models/test_model.rb
+- features/fixtures/delayed_job/app/app/views/layouts/application.html.erb
+- features/fixtures/delayed_job/app/app/views/layouts/mailer.html.erb
+- features/fixtures/delayed_job/app/app/views/layouts/mailer.text.erb
+- features/fixtures/delayed_job/app/config.ru
+- features/fixtures/delayed_job/app/config/application.rb
+- features/fixtures/delayed_job/app/config/boot.rb
+- features/fixtures/delayed_job/app/config/cable.yml
+- features/fixtures/delayed_job/app/config/database.yml
+- features/fixtures/delayed_job/app/config/environment.rb
+- features/fixtures/delayed_job/app/config/environments/development.rb
+- features/fixtures/delayed_job/app/config/environments/production.rb
+- features/fixtures/delayed_job/app/config/environments/test.rb
+- features/fixtures/delayed_job/app/config/initializers/application_controller_renderer.rb
+- features/fixtures/delayed_job/app/config/initializers/assets.rb
+- features/fixtures/delayed_job/app/config/initializers/backtrace_silencers.rb
+- features/fixtures/delayed_job/app/config/initializers/bugsnag.rb
+- features/fixtures/delayed_job/app/config/initializers/cookies_serializer.rb
+- features/fixtures/delayed_job/app/config/initializers/delayed_job.rb
+- features/fixtures/delayed_job/app/config/initializers/filter_parameter_logging.rb
+- features/fixtures/delayed_job/app/config/initializers/inflections.rb
+- features/fixtures/delayed_job/app/config/initializers/mime_types.rb
+- features/fixtures/delayed_job/app/config/initializers/new_framework_defaults.rb
+- features/fixtures/delayed_job/app/config/initializers/session_store.rb
+- features/fixtures/delayed_job/app/config/initializers/wrap_parameters.rb
+- features/fixtures/delayed_job/app/config/locales/en.yml
+- features/fixtures/delayed_job/app/config/puma.rb
+- features/fixtures/delayed_job/app/config/routes.rb
+- features/fixtures/delayed_job/app/config/secrets.yml
+- features/fixtures/delayed_job/app/config/spring.rb
+- features/fixtures/delayed_job/app/db/migrate/20181024232549_create_delayed_jobs.rb
+- features/fixtures/delayed_job/app/db/migrate/20181024232817_create_test_models.rb
+- features/fixtures/delayed_job/app/db/schema.rb
+- features/fixtures/delayed_job/app/db/seeds.rb
+- features/fixtures/delayed_job/app/lib/assets/.keep
+- features/fixtures/delayed_job/app/lib/tasks/.keep
+- features/fixtures/delayed_job/app/log/.keep
+- features/fixtures/delayed_job/app/public/404.html
+- features/fixtures/delayed_job/app/public/422.html
+- features/fixtures/delayed_job/app/public/500.html
+- features/fixtures/delayed_job/app/public/apple-touch-icon-precomposed.png
+- features/fixtures/delayed_job/app/public/apple-touch-icon.png
+- features/fixtures/delayed_job/app/public/favicon.ico
+- features/fixtures/delayed_job/app/public/robots.txt
+- features/fixtures/delayed_job/app/test/controllers/.keep
+- features/fixtures/delayed_job/app/test/fixtures/.keep
+- features/fixtures/delayed_job/app/test/fixtures/files/.keep
+- features/fixtures/delayed_job/app/test/fixtures/test_models.yml
+- features/fixtures/delayed_job/app/test/helpers/.keep
+- features/fixtures/delayed_job/app/test/integration/.keep
+- features/fixtures/delayed_job/app/test/mailers/.keep
+- features/fixtures/delayed_job/app/test/models/.keep
+- features/fixtures/delayed_job/app/test/models/test_model_test.rb
+- features/fixtures/delayed_job/app/test/test_helper.rb
+- features/fixtures/delayed_job/app/tmp/.keep
 - features/fixtures/docker-compose.yml
 - features/fixtures/plain/.dockerignore
 - features/fixtures/plain/Dockerfile
@@ -421,6 +495,7 @@ files:
 - lib/bugsnag/middleware/callbacks.rb
 - lib/bugsnag/middleware/classify_error.rb
 - lib/bugsnag/middleware/clearance_user.rb
+- lib/bugsnag/middleware/delayed_job.rb
 - lib/bugsnag/middleware/exception_meta_data.rb
 - lib/bugsnag/middleware/ignore_error_class.rb
 - lib/bugsnag/middleware/mailman.rb
@@ -463,7 +538,6 @@ files:
 - spec/helper_spec.rb
 - spec/integration_spec.rb
 - spec/integrations/clearance_user_spec.rb
-- spec/integrations/delayed_job_spec.rb
 - spec/integrations/logger_spec.rb
 - spec/integrations/mailman_spec.rb
 - spec/integrations/que_spec.rb
@@ -501,7 +575,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Ruby notifier for bugsnag.com