Skip to content

Commit c2a7302

Browse files
authored
refactor(rails): look up ActiveJob extensions by adapter
1 parent 5c9d744 commit c2a7302

5 files changed

Lines changed: 59 additions & 58 deletions

File tree

‎sentry-rails/lib/sentry/rails.rb‎

Lines changed: 26 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,9 @@ module Rails
2121
#
2222
# When it returns true, the integration captures errors from those jobs,
2323
# records their queue.process transactions and queue.publish spans,
24-
# propagates traces, and consults extensions registered with
25-
# {Sentry.register_job_extension}. A backend gem should then not report the
26-
# same ActiveJob jobs itself.
24+
# propagates traces, and consults the extension registered for the adapter
25+
# with {register_active_job_extension}. A backend gem should then not report
26+
# the same ActiveJob jobs itself.
2727
#
2828
# The result depends on {Sentry.initialized?} and the current configuration,
2929
# so it can change after {Sentry.init}. Call it when a job is handled rather
@@ -38,5 +38,28 @@ module Rails
3838
def self.active_job_owns_adapter?(adapter_class_name)
3939
Sentry.initialized? && !Sentry.configuration.rails.skippable_job_adapters.include?(adapter_class_name.to_s)
4040
end
41+
42+
# Registers the extension that enriches ActiveJob jobs run through a queue
43+
# adapter. Jobs on an adapter without a registered extension use the
44+
# default {ActiveJobExtension}.
45+
#
46+
# @param adapter [Symbol] the adapter's name, as returned by
47+
# +ActiveJob::Base.queue_adapter_name+, such as +:sidekiq+ or +:resque+
48+
# @param extension [ActiveJobExtension] the extension instance
49+
# @return [ActiveJobExtension] the registered extension
50+
# @raise [ArgumentError] if the extension is not an {ActiveJobExtension}
51+
def self.register_active_job_extension(adapter, extension)
52+
unless extension.is_a?(ActiveJobExtension)
53+
raise ArgumentError, "ActiveJob extension must be an instance of #{ActiveJobExtension}, got #{extension.inspect}"
54+
end
55+
56+
active_job_extensions[adapter.to_sym] = extension
57+
end
58+
59+
# @return [Hash{Symbol => ActiveJobExtension}] the registered extensions,
60+
# keyed by adapter name
61+
def self.active_job_extensions
62+
@active_job_extensions ||= {}
63+
end
4164
end
4265
end

‎sentry-rails/lib/sentry/rails/active_job.rb‎

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -59,20 +59,20 @@ def default_extension
5959
@default_extension ||= ActiveJobExtension.new
6060
end
6161

62-
def consumer
63-
@consumer ||= ActiveJobExtension::Consumer.new(registry: job_extensions)
62+
def consumer(job)
63+
extension_for(job).consumer
6464
end
6565

6666
def producer(job)
67-
job_extensions.for(job).producer(job: job)
67+
extension_for(job).producer(job: job)
6868
end
6969

7070
def prepare_payload(job, payload)
7171
safely(job, "inject _sentry payload", fallback: payload) { producer(job).prepare_payload(job, payload) }
7272
end
7373

74-
def job_extensions
75-
default_extension.registry
74+
def extension_for(job)
75+
Sentry::Rails.active_job_extensions.fetch(ActiveJobExtension.adapter_name(job.class), default_extension)
7676
end
7777

7878
def producer_callback_registered?
@@ -111,29 +111,30 @@ def record(job, user: nil, payload: nil, &block)
111111

112112
def record_in_scope(scope, job, user: nil, payload: nil)
113113
transaction = nil
114-
extension = job_extensions.for(job)
114+
job_consumer = consumer(job)
115+
extension = job_consumer.extension
115116

116117
begin
117118
scope.set_user(user.transform_keys(&:to_sym)) if user && !user.empty?
118119

119-
safely(job, "apply scope data") { consumer.apply_scope_data(scope, job) }
120+
safely(job, "apply scope data") { job_consumer.apply_scope_data(scope, job) }
120121
apply_active_job_context(scope, job)
121122

122123
name = safely(job, "name the transaction", fallback: job.class.name) { extension.transaction_name(job: job) }
123124
scope.set_transaction_name(name, source: :task)
124125

125126
transaction = safely(job, "start the transaction") do
126127
trace_headers = extension.extract_trace_headers(job: job, payload: payload)
127-
consumer.start_transaction(scope, job, trace_headers: trace_headers)
128+
job_consumer.start_transaction(scope, job, trace_headers: trace_headers)
128129
end
129130

130131
yield.tap do
131-
consumer.finish_transaction(transaction, 200)
132+
job_consumer.finish_transaction(transaction, 200)
132133
end
133134
rescue Exception => e # rubocop:disable Lint/RescueException
134-
consumer.finish_transaction(transaction, 500)
135+
job_consumer.finish_transaction(transaction, 500)
135136

136-
if safely(job, "decide whether to report the job exception", fallback: true) { consumer.report_exception?(job, e) }
137+
if safely(job, "decide whether to report the job exception", fallback: true) { job_consumer.report_exception?(job, e) }
137138
capture_exception(job, e)
138139
end
139140

@@ -144,7 +145,7 @@ def record_in_scope(scope, job, user: nil, payload: nil)
144145
def capture_exception(job, e)
145146
error_data = active_job_error_data(job)
146147
captured = safely(job, "capture the job exception", fallback: false) do
147-
consumer.capture_exception(job, e, **error_data)
148+
consumer(job).capture_exception(job, e, **error_data)
148149
true
149150
end
150151
return if captured
@@ -174,7 +175,7 @@ def retry_handler(*args)
174175
return if error.nil?
175176
return if !Sentry.initialized? || job.already_supported_by_sentry_integration?
176177
report = safely(job, "decide whether to report the retried exception", fallback: Sentry.configuration.rails.active_job_report_on_retry_error) do
177-
consumer.report_retried_exception?(job, error)
178+
consumer(job).report_retried_exception?(job, error)
178179
end
179180
return unless report
180181

@@ -192,7 +193,7 @@ def handle_error_event(*args)
192193
private
193194

194195
def safely(job, context, fallback: nil, &block)
195-
consumer.safely(job_extensions.for(job), context, fallback: fallback, &block)
196+
consumer(job).safely(context, fallback: fallback, &block)
196197
end
197198

198199
def active_job_error_data(job)

‎sentry-rails/lib/sentry/rails/active_job_extension.rb‎

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,19 +6,21 @@ class ActiveJobExtension < Sentry::JobExtensions::Extension
66
SPAN_ORIGIN = "auto.queue.active_job"
77
USER_FIELDS_ALLOWLIST = %w[id email username].freeze
88

9-
attr_reader :registry
10-
119
def initialize(name: "active_job")
1210
super(name: name)
13-
@registry = Sentry.job_extensions.with_default(self)
1411
end
1512

16-
def handles?(job)
17-
job.is_a?(::ActiveJob::Base)
13+
def self.adapter_name(job_class)
14+
name = job_class.queue_adapter_name if job_class.respond_to?(:queue_adapter_name)
15+
(name || job_class.queue_adapter.class.name.demodulize.delete_suffix("Adapter").underscore).to_sym
16+
end
17+
18+
def consumer
19+
@consumer ||= Consumer.new(extension: self)
1820
end
1921

2022
def producer(job:)
21-
@producer ||= Producer.new(registry: registry)
23+
@producer ||= Producer.new(extension: self)
2224
end
2325

2426
def extract_trace_headers(job:, payload:)

‎sentry-rails/spec/sentry/rails/active_job_job_extensions_spec.rb‎

Lines changed: 9 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -8,16 +8,11 @@
88

99
let(:configure_sentry) { proc { |config| config.traces_sample_rate = 1.0 } }
1010

11-
def register_extension(&body)
12-
klass = Class.new(Sentry::Rails::ActiveJobExtension) do
13-
def handles?(_job)
14-
true
15-
end
16-
17-
class_eval(&body) if body
18-
end
11+
def register_extension(adapter: :test, &body)
12+
klass = Class.new(Sentry::Rails::ActiveJobExtension)
13+
klass.class_eval(&body) if body
1914

20-
Sentry.register_job_extension(klass.new(name: "test_backend"))
15+
Sentry::Rails.register_active_job_extension(adapter, klass.new(name: "test_backend"))
2116
end
2217

2318
def perform_failing_job
@@ -38,8 +33,8 @@ def publish_span
3833
parent.spans.find { |span| span[:op] == "queue.publish" }
3934
end
4035

41-
def register_enriching_extension
42-
register_extension do
36+
def register_enriching_extension(adapter: :test)
37+
register_extension(adapter: adapter) do
4338
def scope_data(job:)
4439
{
4540
contexts: { backend: { "jid" => "backend-jid" }, active_job: { job_id: "backend", attempt: 3 } },
@@ -544,7 +539,7 @@ def mechanism_type(event)
544539
it "leaves the producer span, trace headers and user to an extension that instruments enqueueing the job" do
545540
register_extension do
546541
def producer(job:)
547-
Sentry::JobExtensions::Producer::Delegated.new
542+
Sentry::JobExtensions::Producer::Delegated.new(extension: self)
548543
end
549544
end
550545
Sentry.set_user(id: "42")
@@ -565,8 +560,8 @@ def expect_no_extension_data(event)
565560
expect(event.extra.keys & extension_data_keys).to be_empty
566561
end
567562

568-
it "sends nothing from an extension that does not handle the job" do
569-
register_enriching_extension.define_singleton_method(:handles?) { |_job| false }
563+
it "sends nothing from an extension registered for another adapter" do
564+
register_enriching_extension(adapter: :sidekiq)
570565

571566
within_parent_transaction { failing_job.perform_later }
572567
expect { drain }.to raise_error(RuntimeError, /boom from failing_job spec/)
@@ -576,26 +571,6 @@ def expect_no_extension_data(event)
576571
expect(publish_span[:data]).not_to have_key("messaging.message.receive.latency")
577572
end
578573

579-
it "never consults the registry for jobs on a skipped adapter" do
580-
consulted = []
581-
Sentry.register_job_extension(
582-
Class.new(Sentry::JobExtensions::Extension) do
583-
define_method(:handles?) do |job|
584-
consulted << job
585-
true
586-
end
587-
end.new(name: "observer")
588-
)
589-
Sentry.configuration.rails.skippable_job_adapters = [failing_job.queue_adapter.class.to_s]
590-
591-
expect do
592-
failing_job.perform_later
593-
drain
594-
end.to raise_error(RuntimeError, /boom from failing_job spec/)
595-
596-
expect(consulted).to be_empty
597-
end
598-
599574
context "when every hook raises" do
600575
before do
601576
register_extension do

‎sentry-rails/spec/spec_helper.rb‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@
8888

8989
reset_sentry_globals!
9090

91-
Sentry.job_extensions.clear
91+
Sentry::Rails.active_job_extensions.clear
9292

9393
Rails.application&.cleanup!
9494
end

0 commit comments

Comments
 (0)