bugsnag 6.21.0 → 6.22.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d25c44a654cbfc8684f28ea8ae1853f3aa482abc2741574662afb8368ab8c5b2
-  data.tar.gz: a5c2462967da4d5995a7e07715a310bf5290019943395feef4a782290f2e34c2
+  metadata.gz: 5a06ee3b5502be46d703f258c7bda2a5fca647fbe210095e989dd069af901a78
+  data.tar.gz: 622e923de05d81c2d15fe65d738e7191e75b84230c0bbdcb8fed7c9f6831057c
 SHA512:
-  metadata.gz: 97c2d1764646f0e7fa90fd7c6d9fd4f3811acde1da0cd110a5f186cd164d52fb61fe2a13add1d75f3fd492ccc4c034e63167a4f1c7f06e8586363b95a58788db
-  data.tar.gz: 64c6671f0cddbcdcc71e34ceb4719132f9e503a9e5be9ec73692348b3d023c3b68f572bba05489220dda5eea9f4a4fb89a3559f16d416eb19e6150bf86482640
+  metadata.gz: 7ea25266b534f698108e3bc1cbbfeb81d6b528b77653ffe8edce45b7d6d0309faba4a43f0aeb946ace35b84b738cdd275e12cdc998abc7c2b20c02fa2ea07ed4
+  data.tar.gz: 96a1fe53d1f2167cc3458e53ec178e6c8c25fbde85d1dca17a329da85f9ebde4e72416b5930f9ed595955c48e043e22d60915483e163d0f274a4292a06fa70d8

data/CHANGELOG.md

@@ -1,6 +1,23 @@
 Changelog
 =========
 
+## v6.22.1 (11 August 2021)
+
+### Fixes
+
+* Fix possible `LocalJumpError` introduced in v6.22.0
+  | [#675](https://github.com/bugsnag/bugsnag-ruby/pull/675)
+
+## v6.22.0 (10 August 2021)
+
+### Enhancements
+
+* Add support for tracking exceptions and capturing metadata in Active Job, when not using an existing integration
+  | [#670](https://github.com/bugsnag/bugsnag-ruby/pull/670)
+
+* Improve the report context when using Delayed Job or Resque as the Active Job queue adapter
+  | [#671](https://github.com/bugsnag/bugsnag-ruby/pull/671)
+
 ## v6.21.0 (23 June 2021)
 
 ### Enhancements

data/VERSION

@@ -1 +1 @@
-6.21.0
+6.22.1

data/lib/bugsnag/integrations/rack.rb

@@ -25,9 +25,9 @@ module Bugsnag
         end
 
         # Hook up rack-based notification middlewares
-        config.middleware.insert_before([Bugsnag::Middleware::Rails3Request,Bugsnag::Middleware::Callbacks], Bugsnag::Middleware::RackRequest) if defined?(::Rack)
-        config.middleware.insert_before(Bugsnag::Middleware::Callbacks, Bugsnag::Middleware::WardenUser) if defined?(Warden)
-        config.middleware.insert_before(Bugsnag::Middleware::Callbacks, Bugsnag::Middleware::ClearanceUser) if defined?(Clearance)
+        config.internal_middleware.insert_before(Bugsnag::Middleware::Rails3Request, Bugsnag::Middleware::RackRequest) if defined?(::Rack)
+        config.internal_middleware.use(Bugsnag::Middleware::WardenUser) if defined?(Warden)
+        config.internal_middleware.use(Bugsnag::Middleware::ClearanceUser) if defined?(Clearance)
 
         # Set environment data for payload
         # Note we only set the detected app_type if it's not already set. This

data/lib/bugsnag/integrations/rails/active_job.rb

@@ -0,0 +1,102 @@
+require 'set'
+
+module Bugsnag::Rails
+  module ActiveJob
+    SEVERITY = 'error'
+    SEVERITY_REASON = {
+      type: Bugsnag::Report::UNHANDLED_EXCEPTION_MIDDLEWARE,
+      attributes: { framework: 'Active Job' }
+    }
+
+    EXISTING_INTEGRATIONS = Set[
+      'ActiveJob::QueueAdapters::DelayedJobAdapter',
+      'ActiveJob::QueueAdapters::QueAdapter',
+      'ActiveJob::QueueAdapters::ResqueAdapter',
+      'ActiveJob::QueueAdapters::ShoryukenAdapter',
+      'ActiveJob::QueueAdapters::SidekiqAdapter'
+    ]
+
+    INLINE_ADAPTER = 'ActiveJob::QueueAdapters::InlineAdapter'
+
+    # these methods were added after the first Active Job release so
+    # may not be present, depending on the Rails version
+    MAYBE_MISSING_METHODS = [
+      :provider_job_id,
+      :priority,
+      :executions,
+      :enqueued_at,
+      :timezone
+    ]
+
+    def self.included(base)
+      base.class_eval do
+        around_perform do |job, block|
+          adapter = _bugsnag_get_adapter_name(job)
+
+          # if we have an integration for this queue adapter already then we should
+          # leave this job alone or we'll end up with duplicate metadata
+          next block.call if EXISTING_INTEGRATIONS.include?(adapter)
+
+          Bugsnag.configuration.detected_app_type = 'active job'
+
+          begin
+            Bugsnag.configuration.set_request_data(:active_job, _bugsnag_extract_metadata(job))
+
+            block.call
+          rescue Exception => e
+            Bugsnag.notify(e, true) do |report|
+              report.severity = SEVERITY
+              report.severity_reason = SEVERITY_REASON
+            end
+
+            # when using the "inline" adapter the job is run immediately, which
+            # will result in our Rack integration catching the re-raised error
+            # and reporting it a second time if it's run in a web request
+            if adapter == INLINE_ADAPTER
+              e.instance_eval do
+                def skip_bugsnag
+                  true
+                end
+              end
+            end
+
+            raise
+          ensure
+            Bugsnag.configuration.clear_request_data
+          end
+        end
+      end
+    end
+
+    private
+
+    def _bugsnag_get_adapter_name(job)
+      adapter = job.class.queue_adapter
+
+      # in Rails 4 queue adapters were references to a class. In Rails 5+
+      # they are an instance of that class instead
+      return adapter.name if adapter.is_a?(Class)
+
+      adapter.class.name
+    end
+
+    def _bugsnag_extract_metadata(job)
+      metadata = {
+        job_id: job.job_id,
+        job_name: job.class.name,
+        queue: job.queue_name,
+        arguments: job.arguments,
+        locale: job.locale
+      }
+
+      MAYBE_MISSING_METHODS.each do |method_name|
+        next unless job.respond_to?(method_name)
+
+        metadata[method_name] = job.send(method_name)
+      end
+
+      metadata.compact!
+      metadata
+    end
+  end
+end

data/lib/bugsnag/integrations/railtie.rb

@@ -60,7 +60,7 @@ module Bugsnag
         config.logger = ::Rails.logger
         config.release_stage ||= ::Rails.env.to_s
         config.project_root = ::Rails.root.to_s
-        config.middleware.insert_before Bugsnag::Middleware::Callbacks, Bugsnag::Middleware::Rails3Request
+        config.internal_middleware.use(Bugsnag::Middleware::Rails3Request)
         config.runtime_versions["rails"] = ::Rails::VERSION::STRING
       end
 
@@ -74,6 +74,14 @@ module Bugsnag
         include Bugsnag::Rails::ActiveRecordRescue
       end
 
+      ActiveSupport.on_load(:active_job) do
+        require "bugsnag/middleware/active_job"
+        Bugsnag.configuration.internal_middleware.use(Bugsnag::Middleware::ActiveJob)
+
+        require "bugsnag/integrations/rails/active_job"
+        include Bugsnag::Rails::ActiveJob
+      end
+
       Bugsnag::Rails::DEFAULT_RAILS_BREADCRUMBS.each { |event| event_subscription(event) }
 
       # Make sure we don't overwrite the value set by another integration because

data/lib/bugsnag/integrations/resque.rb

@@ -44,8 +44,18 @@ module Bugsnag
           :attributes => FRAMEWORK_ATTRIBUTES
         }
 
-        context = "#{payload['class']}@#{queue}"
-        report.meta_data.merge!({:context => context, :payload => payload})
+        metadata = payload
+        class_name = payload['class']
+
+        # when using Active Job the payload "class" will always be the Resque
+        # "JobWrapper", not the actual job class so we need to fix this here
+        if metadata['args'] && metadata['args'][0] && metadata['args'][0]['job_class']
+          class_name = metadata['args'][0]['job_class']
+          metadata['wrapped'] ||= class_name
+        end
+
+        context = "#{class_name}@#{queue}"
+        report.meta_data.merge!({ context: context, payload: metadata })
         report.context = context
       end
     end

data/lib/bugsnag/middleware/active_job.rb

@@ -0,0 +1,18 @@
+module Bugsnag::Middleware
+  class ActiveJob
+    def initialize(bugsnag)
+      @bugsnag = bugsnag
+    end
+
+    def call(report)
+      data = report.request_data[:active_job]
+
+      if data
+        report.add_tab(:active_job, data)
+        report.context = "#{data[:job_name]}@#{data[:queue]}"
+      end
+
+      @bugsnag.call(report)
+    end
+  end
+end

data/lib/bugsnag/middleware/delayed_job.rb

@@ -2,6 +2,11 @@ module Bugsnag::Middleware
   ##
   # Attaches delayed_job information to an error report
   class DelayedJob
+    # Active Job's queue adapter sets the "display_name" to this format. This
+    # breaks the event context as the ID and arguments are included, which will
+    # differ between executions of the same job
+    ACTIVE_JOB_DISPLAY_NAME = /^.* \[[0-9a-f-]+\] from DelayedJob\(.*\) with arguments: \[.*\]$/
+
     def initialize(bugsnag)
       @bugsnag = bugsnag
     end
@@ -23,8 +28,10 @@ module Bugsnag::Middleware
         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)
-          report.context ||= payload_data[:class] if payload_data.include?(:class)
+
+          context = get_context(payload_data, job_data[:active_job])
+          report.context = context unless context.nil?
+
           job_data[:payload] = payload_data
         end
 
@@ -70,5 +77,17 @@ module Bugsnag::Middleware
       end
       data
     end
+
+    private
+
+    def get_context(payload_data, active_job_data)
+      if payload_data.include?(:display_name) && !ACTIVE_JOB_DISPLAY_NAME.match?(payload_data[:display_name])
+        payload_data[:display_name]
+      elsif active_job_data && active_job_data['job_class'] && active_job_data['queue_name']
+        "#{active_job_data['job_class']}@#{active_job_data['queue_name']}"
+      elsif payload_data.include?(:class)
+        payload_data[:class]
+      end
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bugsnag
 version: !ruby/object:Gem::Version
-  version: 6.21.0
+  version: 6.22.1
 platform: ruby
 authors:
 - James Smith
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-23 00:00:00.000000000 Z
+date: 2021-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -55,6 +55,7 @@ files:
 - lib/bugsnag/integrations/mongo.rb
 - lib/bugsnag/integrations/que.rb
 - lib/bugsnag/integrations/rack.rb
+- lib/bugsnag/integrations/rails/active_job.rb
 - lib/bugsnag/integrations/rails/active_record_rescue.rb
 - lib/bugsnag/integrations/rails/controller_methods.rb
 - lib/bugsnag/integrations/rails/rails_breadcrumbs.rb
@@ -64,6 +65,7 @@ files:
 - lib/bugsnag/integrations/shoryuken.rb
 - lib/bugsnag/integrations/sidekiq.rb
 - lib/bugsnag/meta_data.rb
+- lib/bugsnag/middleware/active_job.rb
 - lib/bugsnag/middleware/breadcrumbs.rb
 - lib/bugsnag/middleware/callbacks.rb
 - lib/bugsnag/middleware/classify_error.rb