sentry-delayed_job 4.2.1 → 4.5.0.pre.beta.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7eb64abb9fe7d687495e867798a9bbc079cd58cac16d7ac91a6a397292b57058
-  data.tar.gz: 6828b40159946e22cfa840be3bd32b6693a94eb54aba9a98279481658bf754f7
+  metadata.gz: e71b41fbb9ead2dfb1755bed7a0f2bf1ac245d0e7348776552d10640b98ccd9e
+  data.tar.gz: 180c9b9da92a94126a8dadd41c2a5e11e74784f2d297200f938b23c55c7498ba
 SHA512:
-  metadata.gz: 760b9e64122d71ce34dd61ac0d3ea486e2c30408497ed85f1892110c659cb80412c48b906b164ef79a2a67562f3472945e6496848ce0c29f6a10c6ae007959fa
-  data.tar.gz: d486e5e384393e0089e2067e114b60919d278c7db0cbeff7cb18cc56938ee1a6a7fcba96e8a445c77b5e37c0ac65ca15861308b437f1afe03e203e220e69e82f
+  metadata.gz: 7f9a362698b4bed0d3fcd01eeec6144c1cba52288a0aadf219c63d3dc0696c308f15405a72a45d2d10735351f512e1caf9b176baba73db8ea21515bc26463eff
+  data.tar.gz: f98684f3377e74102d7f49e8fd4726b02ca56a153a3130e259c40eafdb108fad4efd0f1ddc3224456cf055b6a277db58d90862934a83c302745823b318ae1538

data/.craft.yml

@@ -11,9 +11,9 @@ artifactProvider:
   name: github
 targets:
     - name: gem
-    - name: github
-      tagPrefix: sentry-delayed_job-v
     - name: registry
       type: sdk
       config:
           canonical: 'gem:sentry-delayed_job'
+    - name: github
+      tagPrefix: sentry-delayed_job-v

data/CHANGELOG.md

@@ -1,5 +1,36 @@
 # Changelog
 
+## 4.4.0
+
+### Features
+
+- Allow delayed job's exceptions to be reported to sentry until the last job retry [#1364](https://github.com/getsentry/sentry-ruby/pull/1364)
+
+Add the `report_after_job_retries` configuration option to only report an exception to Sentry if this is the last job's retry after multiple exceptions. 
+
+```ruby
+config.delayed_job.report_after_job_retries = true # default is false
+```
+
+- Use context for delayed_job's job info [#1395](https://github.com/getsentry/sentry-ruby/pull/1395)
+
+**Before:**
+
+<img width="60%" alt="job info in extra" src="https://user-images.githubusercontent.com/5079556/114307133-de856c00-9b10-11eb-8967-cd0e67e80539.png">
+
+**After:**
+
+<img width="60%" alt="job info in context" src="https://user-images.githubusercontent.com/5079556/114307135-e2b18980-9b10-11eb-9fc4-af885bf0f68d.png">
+
+## 4.3.1
+
+- Return delayed job when the SDK is not initialized [#1373](https://github.com/getsentry/sentry-ruby/pull/1373)
+  - Fixes [#1334](https://github.com/getsentry/sentry-ruby/issues/1334)
+
+## 4.3.0
+
+- No integration-specific changes
+
 ## 4.2.1
 
 - Use ::Rails::Railtie for checking Rails definition [#1287](https://github.com/getsentry/sentry-ruby/pull/1284)

data/lib/sentry-delayed_job.rb

@@ -1,6 +1,7 @@
 require "delayed_job"
 require "sentry-ruby"
 require "sentry/integrable"
+require "sentry/delayed_job/configuration"
 require "sentry/delayed_job/version"
 require "sentry/delayed_job/plugin"
 

data/lib/sentry/delayed_job/configuration.rb

@@ -0,0 +1,21 @@
+module Sentry
+  class Configuration
+    attr_reader :delayed_job
+
+    add_post_initialization_callback do
+      @delayed_job = Sentry::DelayedJob::Configuration.new
+    end
+  end
+
+  module DelayedJob
+    class Configuration
+      # Set this option to true if you want Sentry to only capture the last job
+      # retry if it fails.
+      attr_accessor :report_after_job_retries
+
+      def initialize
+        @report_after_job_retries = false
+      end
+    end
+  end
+end

data/lib/sentry/delayed_job/plugin.rb

@@ -4,16 +4,22 @@ require "delayed_job"
 module Sentry
   module DelayedJob
     class Plugin < ::Delayed::Plugin
+      # need to symbolize strings as keyword arguments in Ruby 2.4~2.6
+      DELAYED_JOB_CONTEXT_KEY = :"Delayed-Job"
+      ACTIVE_JOB_CONTEXT_KEY = :"Active-Job"
+
       callbacks do |lifecycle|
         lifecycle.around(:invoke_job) do |job, *args, &block|
+          next block.call(job, *args) unless Sentry.initialized?
+
           Sentry.with_scope do |scope|
-            scope.set_extras(**generate_extra(job))
+            scope.set_contexts(**generate_contexts(job))
             scope.set_tags("delayed_job.queue" => job.queue, "delayed_job.id" => job.id.to_s)
 
             begin
               block.call(job, *args)
             rescue Exception => e
-              Sentry::DelayedJob.capture_exception(e, hint: { background: false })
+              capture_exception(e, job)
 
               raise
             end
@@ -21,27 +27,43 @@ module Sentry
         end
       end
 
-      def self.generate_extra(job)
-        extra = {
-          "delayed_job.id": job.id.to_s,
-          "delayed_job.priority": job.priority,
-          "delayed_job.attempts": job.attempts,
-          "delayed_job.run_at": job.run_at,
-          "delayed_job.locked_at": job.locked_at,
-          "delayed_job.locked_by": job.locked_by,
-          "delayed_job.queue": job.queue,
-          "delayed_job.created_at": job.created_at,
-          "delayed_job.last_error": job.last_error&.byteslice(0..1000),
-          "delayed_job.handler": job.handler&.byteslice(0..1000)
+      def self.generate_contexts(job)
+        context = {}
+
+        context[DELAYED_JOB_CONTEXT_KEY] = {
+          id: job.id.to_s,
+          priority: job.priority,
+          attempts: job.attempts,
+          run_at: job.run_at,
+          locked_at: job.locked_at,
+          locked_by: job.locked_by,
+          queue: job.queue,
+          created_at: job.created_at,
+          last_error: job.last_error&.byteslice(0..1000),
+          handler: job.handler&.byteslice(0..1000)
         }
 
         if job.payload_object.respond_to?(:job_data)
+          context[ACTIVE_JOB_CONTEXT_KEY] = {}
+
           job.payload_object.job_data.each do |key, value|
-            extra[:"active_job.#{key}"] = value
+            context[ACTIVE_JOB_CONTEXT_KEY][key.to_sym] = value
           end
         end
 
-        extra
+        context
+      end
+
+      def self.capture_exception(exception, job)
+        Sentry::DelayedJob.capture_exception(exception, hint: { background: false }) if report?(job)
+      end
+
+      def self.report?(job)
+        return true unless Sentry.configuration.delayed_job.report_after_job_retries
+
+        # We use the predecessor because the job's attempts haven't been increased to the new
+        # count at this point.
+        job.attempts >= Delayed::Worker.max_attempts.pred
       end
     end
   end

data/lib/sentry/delayed_job/version.rb

@@ -1,5 +1,5 @@
 module Sentry
   module DelayedJob
-    VERSION = "4.2.1"
+    VERSION = "4.5.0-beta.1"
   end
 end

data/sentry-delayed_job.gemspec

@@ -22,5 +22,5 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "sentry-ruby-core", "~> 4.2.0"
+  spec.add_dependency "sentry-ruby-core", "~> 4.5.0-beta.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sentry-delayed_job
 version: !ruby/object:Gem::Version
-  version: 4.2.1
+  version: 4.5.0.pre.beta.1
 platform: ruby
 authors:
 - Sentry Team
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-02-18 00:00:00.000000000 Z
+date: 2021-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sentry-ruby-core
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.2.0
+        version: 4.5.0.pre.beta.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.2.0
+        version: 4.5.0.pre.beta.1
 description: A gem that provides DelayedJob integration for the Sentry error logger
 email: accounts@sentry.io
 executables: []
@@ -47,6 +47,7 @@ files:
 - example/Gemfile
 - example/app.rb
 - lib/sentry-delayed_job.rb
+- lib/sentry/delayed_job/configuration.rb
 - lib/sentry/delayed_job/plugin.rb
 - lib/sentry/delayed_job/version.rb
 - sentry-delayed_job.gemspec
@@ -68,11 +69,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: A gem that provides DelayedJob integration for the Sentry error logger