sentry-delayed_job 4.3.0 → 4.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 31b71a6705433af7755c02ede20348408ba91a1b329a3e8fe17bdf5b9e7dab16
-  data.tar.gz: f6375ecf44331674fe16ba55982019829d1f1499c01fdb2115d1d932554cd179
+  metadata.gz: 056a402ebaef3f63d8e96643e694307e20b77c480c084128248ea6adf9d4bccc
+  data.tar.gz: f07073033d5cbb695c6dabe5a00bef1cbba3b22fdbb0320a2dcc4977bfb34f99
 SHA512:
-  metadata.gz: 754ddf0fcd84140eec97cd2cb742dc2241169a7367d9ad545f78a131b2c1933c6fabfdac7c54d9b9727dee80d046be2680c9630967a9d19d63605c056403f741
-  data.tar.gz: 292573fa1e44cf7be0d0464561aa1d5f70cdca7b4cc0f2951712e845884d6f1711ef9c1af4a7312e810659060135cb4988b7d0f5e591d3d9dd451116d16cd244
+  metadata.gz: aa7deb183518153ca434001065cecb46d79f23e948b282ec031bf93cc61ec9c744427949f714b19ad9b0a5f5c7cc80cdb4583124efeaa1ea696fe85476865a00
+  data.tar.gz: 4890714298f5f9dfe5704fd441630524fb3adcf56f068243357259a136f94026b33e34a55c788bb305dff54b62a46a615043b406b1319cfa4a83e38b22e660d4

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,34 @@
 # Changelog
 
+Individual gem's changelog has been deprecated. Please check the [project changelog](https://github.com/getsentry/sentry-ruby/blob/master/CHANGELOG.md).
+
+## 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

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.3.0"
+    VERSION = "4.5.0"
   end
 end

data/sentry-delayed_job.gemspec

@@ -16,11 +16,11 @@ Gem::Specification.new do |spec|
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = spec.homepage
-  spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/master/sentry-delayed_job/CHANGELOG.md"
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/master/CHANGELOG.md"
 
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "sentry-ruby-core", "~> 4.3.0"
+  spec.add_dependency "sentry-ruby-core", "~> 4.5.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sentry-delayed_job
 version: !ruby/object:Gem::Version
-  version: 4.3.0
+  version: 4.5.0
 platform: ruby
 authors:
 - Sentry Team
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-03-12 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.3.0
+        version: 4.5.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.3.0
+        version: 4.5.0
 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
@@ -56,7 +57,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/getsentry/sentry-ruby
   source_code_uri: https://github.com/getsentry/sentry-ruby
-  changelog_uri: https://github.com/getsentry/sentry-ruby/blob/master/sentry-delayed_job/CHANGELOG.md
+  changelog_uri: https://github.com/getsentry/sentry-ruby/blob/master/CHANGELOG.md
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -72,7 +73,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 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