fix(active_job): use background: true like integration gems

Author: solnic

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

@@ -200,7 +200,10 @@ def capture_exception(job, e)
               tags: {
                 job_id: job.job_id,
                 provider_job_id: job.provider_job_id
-              }
+              },
+              # Send synchronously: a worker process may exit before the async
+              # background worker flushes its queue, which would drop the event.
+              hint: { background: false }
             )
           end
 

sentry-rails/spec/active_job/shared_examples/error_capture.rb

@@ -20,4 +20,28 @@ def perform
     exception = extract_sentry_exceptions(sentry_events.last).first
     expect(exception.value).to match(/boom from failing_job spec/)
   end
+
+  context "when the background worker exits before flushing" do
+    let(:background_worker) { ManualBackgroundWorker.new }
+
+    let(:sentry_test_config) do
+      proc { |config| config.background_worker_threads = 1 }
+    end
+
+    before { Sentry.background_worker = background_worker }
+
+    it "captures the error synchronously so it survives the worker exiting" do
+      expect do
+        failing_job.perform_later
+        drain
+      end.to raise_error(RuntimeError, /boom from failing_job spec/)
+
+      expect(background_worker.pending).to be_empty
+      expect(sentry_events.size).to eq(1)
+
+      background_worker.drop!
+
+      expect(sentry_events.size).to eq(1)
+    end
+  end
 end

sentry-rails/spec/active_job/support/harness.rb

@@ -16,6 +16,7 @@
 RSpec.shared_context "active_job backend harness" do |adapter:|
   let(:adapter) { adapter }
   let(:configure_sentry) { proc { } }
+  let(:sentry_test_config) { nil }
 
   # Boot the dummy Rails app ONCE per example group. Each +make_basic_app+
   # call creates a new +Rails::Application+ subclass and re-runs every
@@ -63,7 +64,7 @@
       Sentry::Rails::ActiveJobExtensions::SentryReporter.register_event_handlers
     end
 
-    setup_sentry_test
+    setup_sentry_test(&sentry_test_config)
 
     boot_adapter(adapter)
 

sentry-rails/spec/active_job/support/manual_background_worker.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+# A background worker stand-in that captures posted work without running it,
+# so a spec can deterministically simulate a worker that exits before flushing
+# its queue (#drop!) versus one that drains cleanly (#flush).
+class ManualBackgroundWorker
+  attr_reader :pending
+
+  def initialize
+    @pending = []
+  end
+
+  # Mirrors Sentry::BackgroundWorker#perform; a truthy return keeps
+  # Client#capture_event from recording a :queue_overflow lost event.
+  def perform(&block)
+    @pending << block
+    true
+  end
+
+  def flush
+    @pending.each(&:call)
+    @pending.clear
+  end
+
+  # Simulate a hard worker exit: queued events are lost.
+  def drop!
+    @pending.clear
+  end
+
+  def shutdown; end
+end