Add max_nesting of 10 to breadcrumbs data serialization (#2583)

This is [enforced in [relay](https://github.com/getsentry/relay/blob/bcbfa7e7db6e4a8f3f0383270fbb2b5cfe668770/relay-event-schema/src/protocol/breadcrumb.rs#L111) at a depth of 5.
We allow upto 10 to have some leeway but if we have a really large data
object we just drop it to avoid SystemStackError.

Closes #2393 and #2397

Author: sl0thentr0py

CHANGELOG.md

@@ -3,6 +3,7 @@
 ### Features
 
 - Add new sidekiq config `report_only_dead_jobs` ([#2581](https://github.com/getsentry/sentry-ruby/pull/2581))
+- Add `max_nesting` of 10 to breadcrumbs data serialization ([#2583](https://github.com/getsentry/sentry-ruby/pull/2583))
 
 ### Bug Fixes
 

sentry-ruby/lib/sentry/breadcrumb.rb

@@ -2,6 +2,7 @@
 
 module Sentry
   class Breadcrumb
+    MAX_NESTING = 10
     DATA_SERIALIZATION_ERROR_MESSAGE = "[data were removed due to serialization issues]"
 
     # @return [String, nil]
@@ -60,7 +61,7 @@ def level=(level) # needed to meet the Sentry spec
 
     def serialized_data
       begin
-        ::JSON.parse(::JSON.generate(@data))
+        ::JSON.parse(::JSON.generate(@data, max_nesting: MAX_NESTING))
       rescue Exception => e
         Sentry.logger.debug(LOGGER_PROGNAME) do
           <<~MSG

sentry-ruby/spec/sentry/breadcrumb_spec.rb

@@ -3,8 +3,12 @@
 require "spec_helper"
 
 RSpec.describe Sentry::Breadcrumb do
+  let(:stringio) { StringIO.new }
+
   before do
-    perform_basic_setup
+    perform_basic_setup do |config|
+      config.logger = ::Logger.new(stringio)
+    end
   end
 
   let(:crumb) do
@@ -77,6 +81,16 @@
       )
     end
 
+    let(:very_deep_crumb) do
+      data = [[[[[ { a: [{ b: [[{ c: 4 }]] }] }]]]]]
+
+      Sentry::Breadcrumb.new(
+        category: "cow",
+        message: "I cause too much recursion",
+        data: data
+      )
+    end
+
     it "serializes data correctly" do
       result = crumb.to_hash
 
@@ -91,6 +105,16 @@
       expect(result[:category]).to eq("baz")
       expect(result[:message]).to eq("I cause issues")
       expect(result[:data]).to eq("[data were removed due to serialization issues]")
+      expect(stringio.string).to match(/can't serialize breadcrumb data because of error: nesting of 10 is too deep/)
+    end
+
+    it "rescues data serialization issue for extremely nested data and ditch the data" do
+      result = very_deep_crumb.to_hash
+
+      expect(result[:category]).to eq("cow")
+      expect(result[:message]).to eq("I cause too much recursion")
+      expect(result[:data]).to eq("[data were removed due to serialization issues]")
+      expect(stringio.string).to match(/can't serialize breadcrumb data because of error: nesting of 10 is too deep/)
     end
   end
 end