sentry-delayed_job 5.16.1 → 5.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bd65248bd96ef0128bdea13f9bbbffaf40f254baf08994bb068ccfe26ab91e0f
-  data.tar.gz: 3644f99752eb096f9e78b98cc63ee7a205cb9cd13b3e1fa98fbd55f366c37a6b
+  metadata.gz: 1982ed4c43b807a18a08dc82a6ff89c4145d043fb3f05c2450383fcf5b02e0fd
+  data.tar.gz: 43c8fcd55480b2d17cc8a872b43a93e3a43683527fa768437f395f64af9fa86d
 SHA512:
-  metadata.gz: 560f853d6952c43de01a2e818202b389d16357ecedcbfea1c708607678469249b3271ef8a78d1f3de29a53f2a659575de1aa1bd97d8dc1e09bd966081a120858
-  data.tar.gz: faaf2a4da2e76e82cd5aa97dad2ea9a3dc003d7d55a62ac61d32965bb7dd32e07909809e6a79a1121de185564a464e034bfc2c451fb5337f21a12c5f2dbc6169
+  metadata.gz: 572a579f738ec7d483be96b197c28cbb69a143c39c8fd90dec9a6d9c8bd17d7661139edf72bda94f273888401835deae62723b1aff137fa8e438a8f0893a80c3
+  data.tar.gz: f32de1898887c2a72654c085541d72a0b9d345fd72a2a721fd9fc6cef62e92bb6e2f7f7457700618fd52336a663bc7ecaf9288d8a182c9e06f36bb92426e86b8

data/Rakefile

@@ -5,4 +5,4 @@ RSpec::Core::RakeTask.new(:spec).tap do |task|
   task.rspec_opts = "--order rand"
 end
 
-task :default => :spec
+task default: :spec

data/example/Gemfile

@@ -7,5 +7,4 @@ gem 'delayed_job_active_record'
 gem "sentry-delayed_job", path: "../"
 gem "sentry-ruby", path: "../../sentry-ruby"
 
-gem "pry"
 gem "debug", github: "ruby/debug"

data/example/app.rb

@@ -1,4 +1,3 @@
-require "pry"
 require "active_job"
 require "active_record"
 require "delayed_job"
@@ -64,5 +63,3 @@ begin
 rescue => e
   puts("inline job failed because of \"#{e.message}\"")
 end
-
-

data/lib/sentry/delayed_job/plugin.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require "delayed_job"
 
 module Sentry
@@ -10,7 +11,12 @@ module Sentry
       OP_NAME = "queue.delayed_job".freeze
 
       callbacks do |lifecycle|
+        lifecycle.before(:enqueue) do |job, *args, &block|
+          inject_trace_data(job) if Sentry.initialized?
+        end
+
         lifecycle.around(:invoke_job) do |job, *args, &block|
+          env = extract_trace_data(job)
           next block.call(job, *args) unless Sentry.initialized?
 
           Sentry.with_scope do |scope|
@@ -20,12 +26,7 @@ module Sentry
             scope.set_contexts(**contexts)
             scope.set_tags("delayed_job.queue" => job.queue, "delayed_job.id" => job.id.to_s)
 
-            transaction = Sentry.start_transaction(
-              name: scope.transaction_name,
-              source: scope.transaction_source,
-              op: OP_NAME,
-              custom_sampling_context: contexts
-            )
+            transaction = start_transaction(scope, env, contexts)
             scope.set_span(transaction) if transaction
 
             begin
@@ -55,7 +56,7 @@ module Sentry
           created_at: job.created_at,
           last_error: job.last_error&.byteslice(0..1000),
           handler: job.handler&.byteslice(0..1000),
-          job_class: compute_job_class(job.payload_object),
+          job_class: compute_job_class(job.payload_object)
         }
 
         if job.payload_object.respond_to?(:job_data)
@@ -70,7 +71,7 @@ module Sentry
       end
 
       def self.compute_job_class(payload_object)
-        if payload_object.is_a? Delayed::PerformableMethod
+        if payload_object.is_a?(Delayed::PerformableMethod)
           klass = payload_object.object.is_a?(Class) ? payload_object.object.name : payload_object.object.class.name
           "#{klass}##{payload_object.method_name}"
         else
@@ -91,12 +92,40 @@ module Sentry
         job.attempts >= max_attempts
       end
 
+      def self.start_transaction(scope, env, contexts)
+        options = { name: scope.transaction_name, source: scope.transaction_source, op: OP_NAME }
+        transaction = Sentry.continue_trace(env, **options)
+        Sentry.start_transaction(transaction: transaction, custom_sampling_context: contexts, **options)
+      end
+
       def self.finish_transaction(transaction, status)
         return unless transaction
 
         transaction.set_http_status(status)
         transaction.finish
       end
+
+      def self.inject_trace_data(job)
+        # active job style is handled in the sentry-rails/active_job extension more generally
+        # if someone enqueues manually with some other job class, we cannot make assumptions unfortunately
+        payload_object = job.payload_object
+        return unless payload_object.is_a?(Delayed::PerformableMethod)
+
+        # we will add the trace data to args and remove it again
+        # this is hacky but it's the only reliable way to survive the YAML serialization/deserialization
+        payload_object.args << { sentry: Sentry.get_trace_propagation_headers }
+        job.payload_object = payload_object
+      end
+
+      def self.extract_trace_data(job)
+        payload_object = job.payload_object
+        return nil unless payload_object.is_a?(Delayed::PerformableMethod)
+
+        target_payload = payload_object.args.find { |a| a.is_a?(Hash) && a.key?(:sentry) }
+        return nil unless target_payload
+        payload_object.args.delete(target_payload)
+        target_payload[:sentry]
+      end
     end
   end
 end

data/lib/sentry/delayed_job/version.rb

@@ -1,5 +1,5 @@
 module Sentry
   module DelayedJob
-    VERSION = "5.16.1"
+    VERSION = "5.17.0"
   end
 end

data/sentry-delayed_job.gemspec

@@ -22,6 +22,6 @@ 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", "~> 5.16.1"
+  spec.add_dependency "sentry-ruby", "~> 5.17.0"
   spec.add_dependency "delayed_job", ">= 4.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sentry-delayed_job
 version: !ruby/object:Gem::Version
-  version: 5.16.1
+  version: 5.17.0
 platform: ruby
 authors:
 - Sentry Team
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-01-09 00:00:00.000000000 Z
+date: 2024-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sentry-ruby
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.16.1
+        version: 5.17.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.16.1
+        version: 5.17.0
 - !ruby/object:Gem::Dependency
   name: delayed_job
   requirement: !ruby/object:Gem::Requirement