Add hint: support to Sentry::Rails::ErrorSubscriber

CHANGELOG.md

@@ -1,6 +1,9 @@
 ## Unreleased
 
+### Features
+
 - Fix warning about default gems on Ruby 3.3.0 ([#2225](https://github.com/getsentry/sentry-ruby/pull/2225))
+- Add `hint:` support to `Sentry::Rails::ErrorSubscriber` [#2235](https://github.com/getsentry/sentry-ruby/pull/2235)
 
 ## 5.16.1
 

sentry-rails/lib/sentry/rails/error_subscriber.rb

@@ -19,7 +19,13 @@ def report(error, handled:, severity:, context:, source: nil)
           tags.merge!(context.delete(:tags))
         end
 
-        Sentry::Rails.capture_exception(error, level: severity, contexts: { "rails.error" => context }, tags: tags)
+        hint = {}
+        if context[:hint].is_a?(Hash)
+          context = context.dup
+          hint.merge!(context.delete(:hint))
+        end
+
+        Sentry::Rails.capture_exception(error, level: severity, contexts: { "rails.error" => context }, tags: tags, hint: hint)
       end
     end
   end

sentry-rails/spec/sentry/rails/error_subscriber_spec.rb

@@ -68,5 +68,41 @@
         end
       end
     end
+
+    context 'when passed a context with hint key' do
+      context 'when hint is a Hash' do
+        it 'merges the hint into the event' do
+          expect(Sentry::Rails).to receive(:capture_exception) do |_, hint:, **_|
+            expect(hint[:foo]).to eq('bar')
+          end
+          described_class.new.report(StandardError.new, handled: true, severity: :error, context: { hint: { foo: 'bar' } })
+        end
+
+        it 'does not pass the hint to the context' do
+          expect(Sentry::Rails).to receive(:capture_exception) do |_, contexts:, **_|
+            expect(contexts["rails.error"]).not_to have_key(:hint)
+          end
+          described_class.new.report(StandardError.new, handled: true, severity: :error, context: { hint: { foo: 'bar' } })
+        end
+      end
+
+
+      context 'when hint is not a Hash' do
+        it 'does not merge the hint into the event' do
+          expect(Sentry::Rails).to receive(:capture_exception) do |_, hint:, **_|
+            expect(hint).not_to have_key(:foo)
+          end
+          described_class.new.report(StandardError.new, handled: true, severity: :error, context: { hint: 'foo' })
+        end
+
+        it 'passes the hint to the context' do
+          expect(Sentry::Rails).to receive(:capture_exception) do |_, contexts:, **_|
+            expect(contexts["rails.error"][:hint]).to eq('foo')
+          end
+          described_class.new.report(StandardError.new, handled: true, severity: :error, context: { hint: 'foo' })
+        end
+      end
+    end
+
   end
 end