Gracefully fail on malformed utf-8 breadcrumb message (#2582)

Author: sl0thentr0py

CHANGELOG.md

@@ -1,3 +1,10 @@
+## Unreleased
+
+### Bug Fixes
+
+- Gracefully fail on malformed utf-8 breadcrumb message ([#2582](https://github.com/getsentry/sentry-ruby/pull/2582))
+  - Fixes [#2376](https://github.com/getsentry/sentry-ruby/issues/2376)
+
 ## 5.23.0
 
 ### Features

sentry-ruby/lib/sentry/breadcrumb.rb

@@ -47,7 +47,7 @@ def to_hash
     # @param message [String]
     # @return [void]
     def message=(message)
-      @message = message ? message.byteslice(0..Event::MAX_MESSAGE_SIZE_IN_BYTES) : ""
+      @message = message && Utils::EncodingHelper.valid_utf_8?(message) ? message.byteslice(0..Event::MAX_MESSAGE_SIZE_IN_BYTES) : ""
     end
 
     # @param level [String]

sentry-ruby/spec/sentry/breadcrumb_spec.rb

@@ -40,6 +40,12 @@
       crumb.message = long_message
       expect(crumb.message.length).to eq(Sentry::Event::MAX_MESSAGE_SIZE_IN_BYTES + 1)
     end
+
+    it "removes bad encoding message gracefully" do
+      crumb = described_class.new
+      crumb.message = "foo \x1F\xE6"
+      expect(crumb.message).to eq("")
+    end
   end
 
   describe "#level=" do

sentry-ruby/spec/sentry/transport_spec.rb

@@ -237,6 +237,22 @@
       end
     end
 
+    context "malformed breadcrumb" do
+      let(:event) { client.event_from_message("foo") }
+
+      before do
+        event.breadcrumbs = Sentry::BreadcrumbBuffer.new(1000)
+        breadcrumb = Sentry::Breadcrumb.new(message: "foo \x1F\xE6")
+        event.breadcrumbs.record(breadcrumb)
+      end
+
+      it "gracefully removes bad encoding breadcrumb message" do
+        expect do
+          serialized_result = JSON.generate(event.to_hash)
+        end.not_to raise_error
+      end
+    end
+
     context "oversized event" do
       context "due to breadcrumb" do
         let(:event) { client.event_from_message("foo") }