Disable background worker when executing rake tasks (#1509)

st0012 · web-flow · commit 4dc603b4f45e · 2021-07-23T14:37:35.000+08:00
* Add Hub#with_background_worker_disabled

This helper temporarily disables background event dispatching when
executing the block.

* Wrap rake task's execution with Hub#with_background_worker_disabled

This makes sure all events, whether manually triggered or handled by the
SDK, can be sent synchronously.

* Update changelog
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,8 @@
 - Declare `delayed_job` and `sidekiq` as integration gem's dependency [#1506](https://github.com/getsentry/sentry-ruby/pull/1506)
 - `DSN#server` shouldn't include path [#1505](https://github.com/getsentry/sentry-ruby/pull/1505)
 - Fix `sentry-rails`' `backtrace_cleanup_callback` injection [#1510](https://github.com/getsentry/sentry-ruby/pull/1510)
+- Disable background worker when executing rake tasks [#1509](https://github.com/getsentry/sentry-ruby/pull/1509)
+  - Fixes [#1508](https://github.com/getsentry/sentry-ruby/issues/1508)
 
 ## 4.6.1
 
diff --git a/sentry-ruby/examples/rake/Rakefile.rb b/sentry-ruby/examples/rake/Rakefile.rb
@@ -7,3 +7,7 @@
 task :raise_exception do
   1/0
 end
+
+task :send_message do
+  Sentry.capture_message("message from rake")
+end
diff --git a/sentry-ruby/lib/sentry/hub.rb b/sentry-ruby/lib/sentry/hub.rb
@@ -144,6 +144,17 @@ def add_breadcrumb(breadcrumb, hint: {})
       current_scope.add_breadcrumb(breadcrumb)
     end
 
+    # this doesn't do anything to the already initialized background worker
+    # but it temporarily disables dispatching events to it
+    def with_background_worker_disabled(&block)
+      original_background_worker_threads = configuration.background_worker_threads
+      configuration.background_worker_threads = 0
+
+      block.call
+    ensure
+      configuration.background_worker_threads = original_background_worker_threads
+    end
+
     private
 
     def current_layer
diff --git a/sentry-ruby/lib/sentry/rake.rb b/sentry-ruby/lib/sentry/rake.rb
@@ -3,6 +3,7 @@
 
 module Rake
   class Application
+
     alias orig_display_error_messsage display_error_message
     def display_error_message(ex)
       Sentry.capture_exception(ex, hint: { background: false }) do |scope|
@@ -14,4 +15,16 @@ def display_error_message(ex)
       orig_display_error_messsage(ex)
     end
   end
+
+  class Task
+    alias orig_execute execute
+
+    def execute(args=nil)
+      return orig_execute unless Sentry.initialized? && Sentry.get_current_hub
+
+      Sentry.get_current_hub.with_background_worker_disabled do
+        orig_execute
+      end
+    end
+  end
 end
diff --git a/sentry-ruby/spec/sentry/hub_spec.rb b/sentry-ruby/spec/sentry/hub_spec.rb
@@ -397,4 +397,51 @@
       expect(subject.last_event_id).to eq(event.event_id)
     end
   end
+
+  describe "#with_background_worker_disabled" do
+    before do
+      configuration.background_worker_threads = 5
+      Sentry.background_worker = Sentry::BackgroundWorker.new(configuration)
+      configuration.before_send = lambda do |event, _hint|
+        sleep 0.5
+        event
+      end
+    end
+
+    after do
+      Sentry.background_worker = nil
+    end
+
+    it "disables async event sending temporarily" do
+      subject.with_background_worker_disabled do
+        subject.capture_message("foo")
+      end
+
+      expect(transport.events.count).to eq(1)
+    end
+
+    it "returns the original execution result" do
+      result = subject.with_background_worker_disabled do
+        "foo"
+      end
+
+      expect(result).to eq("foo")
+    end
+
+    it "doesn't interfere events outside of the block" do
+      subject.with_background_worker_disabled {}
+
+      subject.capture_message("foo")
+      expect(transport.events.count).to eq(0)
+    end
+
+    it "resumes the backgrounding state even with exception" do
+      subject.with_background_worker_disabled do
+        raise "foo"
+      end rescue nil
+
+      subject.capture_message("foo")
+      expect(transport.events.count).to eq(0)
+    end
+  end
 end
