sentry-ruby 6.1.0 → 6.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a166b422dd9fc77ede5fcc2d11f6f5556db89bb0e545ad44c06354cb1574d976
-  data.tar.gz: 067fb812d95c439bd060c65795cf3cc3e66b4f22cf5b681108f92ea4f6e35b69
+  metadata.gz: 0c7e991a71c48c638739ac8ce5800da3796ea8847cf2957eee2a44b6b04233fc
+  data.tar.gz: 4a1981f39e3dac807e4c14fb50372467a46bf3f01331d0c6d61c3b27cc46e26c
 SHA512:
-  metadata.gz: 04bf6ca584de8a34cbc3e860b8e54082e5f5dd9c31626be8cd7f4698b718ac94c4d104982351de858f52ac640e9ac41b9d5ea2aee54552f1dc23e949d5ef33c3
-  data.tar.gz: 80d82500a25f462656f4f4abcfcda630b0e7f8afe07c2530feede5032ea1b5f5587da1b5eca43d11c5699e683b90db69a89815a31e490c765bb8b8d5a893985f
+  metadata.gz: 39f12421ae5bc3fbbd0899f595cd7a614fdf613f68f2bf1b265640dd8d874dc387c68a959b6c16fdc6255000886fa1cdbd88279835d0c9a0ea5566b40cc03e16
+  data.tar.gz: 6020209a29b8ba823c5da7035e8a634e5355d839f77fc4d4232d3633aeadf3d88f46aba492456ec281984cbd12ec0d2948b8a8c0baca880a89799840e1ed97b3

data/README.md

@@ -107,7 +107,7 @@ To learn more about sampling transactions, please visit the [official documentat
 * [![Forum](https://img.shields.io/badge/forum-sentry-green.svg)](https://forum.sentry.io/c/sdks)
 * [![Discord Chat](https://img.shields.io/discord/621778831602221064?logo=discord&logoColor=ffffff&color=7389D8)](https://discord.gg/PXa5Apfe7K)
 * [![Stack Overflow](https://img.shields.io/badge/stack%20overflow-sentry-green.svg)](https://stackoverflow.com/questions/tagged/sentry)
-* [![Twitter Follow](https://img.shields.io/twitter/follow/getsentry?label=getsentry&style=social)](https://twitter.com/intent/follow?screen_name=getsentry)
+* [![X Follow](https://img.shields.io/twitter/follow/sentry?label=sentry&style=social)](https://x.com/intent/follow?screen_name=sentry)
 
 ## Contributing to the SDK
 

data/lib/sentry/backtrace/line.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+module Sentry
+  # @api private
+  class Backtrace
+    # Handles backtrace parsing line by line
+    class Line
+      RB_EXTENSION = ".rb"
+      # regexp (optional leading X: on windows, or JRuby9000 class-prefix)
+      RUBY_INPUT_FORMAT = /
+        ^ \s* (?: [a-zA-Z]: | uri:classloader: )? ([^:]+ | <.*>):
+        (\d+)
+        (?: :in\s('|`)(?:([\w:]+)\#)?([^']+)')?$
+      /x
+
+      # org.jruby.runtime.callsite.CachingCallSite.call(CachingCallSite.java:170)
+      JAVA_INPUT_FORMAT = /^([\w$.]+)\.([\w$]+)\(([\w$.]+):(\d+)\)$/
+
+      # The file portion of the line (such as app/models/user.rb)
+      attr_reader :file
+
+      # The line number portion of the line
+      attr_reader :number
+
+      # The method of the line (such as index)
+      attr_reader :method
+
+      # The module name (JRuby)
+      attr_reader :module_name
+
+      attr_reader :in_app_pattern
+
+      # Parses a single line of a given backtrace
+      # @param [String] unparsed_line The raw line from +caller+ or some backtrace
+      # @return [Line] The parsed backtrace line
+      def self.parse(unparsed_line, in_app_pattern = nil)
+        ruby_match = unparsed_line.match(RUBY_INPUT_FORMAT)
+
+        if ruby_match
+          _, file, number, _, module_name, method = ruby_match.to_a
+          file.sub!(/\.class$/, RB_EXTENSION)
+          module_name = module_name
+        else
+          java_match = unparsed_line.match(JAVA_INPUT_FORMAT)
+          _, module_name, method, file, number = java_match.to_a
+        end
+        new(file, number, method, module_name, in_app_pattern)
+      end
+
+      # Creates a Line from a Thread::Backtrace::Location object
+      # This is more efficient than converting to string and parsing with regex
+      # @param [Thread::Backtrace::Location] location The location object
+      # @param [Regexp, nil] in_app_pattern Optional pattern to determine if the line is in-app
+      # @return [Line] The backtrace line
+      def self.from_source_location(location, in_app_pattern = nil)
+        file = location.absolute_path
+        number = location.lineno
+        method = location.base_label
+
+        label = location.label
+        index = label.index("#") || label.index(".")
+        module_name = label[0, index] if index
+
+        new(file, number, method, module_name, in_app_pattern)
+      end
+
+      def initialize(file, number, method, module_name, in_app_pattern)
+        @file = file
+        @module_name = module_name
+        @number = number.to_i
+        @method = method
+        @in_app_pattern = in_app_pattern
+      end
+
+      def in_app
+        return false unless in_app_pattern
+
+        if file =~ in_app_pattern
+          true
+        else
+          false
+        end
+      end
+
+      # Reconstructs the line in a readable fashion
+      def to_s
+        "#{file}:#{number}:in `#{method}'"
+      end
+
+      def ==(other)
+        to_s == other.to_s
+      end
+
+      def inspect
+        "<Line:#{self}>"
+      end
+    end
+  end
+end

data/lib/sentry/backtrace.rb

@@ -1,86 +1,12 @@
 # frozen_string_literal: true
 
 require "rubygems"
+require "concurrent/map"
+require "sentry/backtrace/line"
 
 module Sentry
   # @api private
   class Backtrace
-    # Handles backtrace parsing line by line
-    class Line
-      RB_EXTENSION = ".rb"
-      # regexp (optional leading X: on windows, or JRuby9000 class-prefix)
-      RUBY_INPUT_FORMAT = /
-        ^ \s* (?: [a-zA-Z]: | uri:classloader: )? ([^:]+ | <.*>):
-        (\d+)
-        (?: :in\s('|`)(?:([\w:]+)\#)?([^']+)')?$
-      /x
-
-      # org.jruby.runtime.callsite.CachingCallSite.call(CachingCallSite.java:170)
-      JAVA_INPUT_FORMAT = /^([\w$.]+)\.([\w$]+)\(([\w$.]+):(\d+)\)$/
-
-      # The file portion of the line (such as app/models/user.rb)
-      attr_reader :file
-
-      # The line number portion of the line
-      attr_reader :number
-
-      # The method of the line (such as index)
-      attr_reader :method
-
-      # The module name (JRuby)
-      attr_reader :module_name
-
-      attr_reader :in_app_pattern
-
-      # Parses a single line of a given backtrace
-      # @param [String] unparsed_line The raw line from +caller+ or some backtrace
-      # @return [Line] The parsed backtrace line
-      def self.parse(unparsed_line, in_app_pattern = nil)
-        ruby_match = unparsed_line.match(RUBY_INPUT_FORMAT)
-
-        if ruby_match
-          _, file, number, _, module_name, method = ruby_match.to_a
-          file.sub!(/\.class$/, RB_EXTENSION)
-          module_name = module_name
-        else
-          java_match = unparsed_line.match(JAVA_INPUT_FORMAT)
-          _, module_name, method, file, number = java_match.to_a
-        end
-        new(file, number, method, module_name, in_app_pattern)
-      end
-
-      def initialize(file, number, method, module_name, in_app_pattern)
-        @file = file
-        @module_name = module_name
-        @number = number.to_i
-        @method = method
-        @in_app_pattern = in_app_pattern
-      end
-
-      def in_app
-        return false unless in_app_pattern
-
-        if file =~ in_app_pattern
-          true
-        else
-          false
-        end
-      end
-
-      # Reconstructs the line in a readable fashion
-      def to_s
-        "#{file}:#{number}:in `#{method}'"
-      end
-
-      def ==(other)
-        to_s == other.to_s
-      end
-
-      def inspect
-        "<Line:#{self}>"
-      end
-    end
-
     # holder for an Array of Backtrace::Line instances
     attr_reader :lines
 
@@ -100,6 +26,48 @@ module Sentry
       new(lines)
     end
 
+    # Thread.each_caller_location is an API added in Ruby 3.2 that doesn't always collect
+    # the entire stack like Kernel#caller or #caller_locations do.
+    #
+    # @see https://github.com/rails/rails/pull/49095 for more context.
+    if Thread.respond_to?(:each_caller_location)
+      def self.source_location(&backtrace_cleaner)
+        Thread.each_caller_location do |location|
+          frame_key = [location.absolute_path, location.lineno]
+          cached_value = line_cache[frame_key]
+
+          next if cached_value == :skip
+
+          if cached_value
+            return cached_value
+          else
+            if cleaned_frame = backtrace_cleaner.(location)
+              line = Line.from_source_location(location)
+              line_cache[frame_key] = line
+
+              return line
+            else
+              line_cache[frame_key] = :skip
+
+              next
+            end
+          end
+        end
+      end
+
+      def self.line_cache
+        @line_cache ||= Concurrent::Map.new
+      end
+    else
+      # Since Sentry is mostly used in production, we don't want to fallback
+      # to the slower implementation and adds potentially big overhead to the
+      # application.
+      def self.source_location(*)
+        nil
+      end
+    end
+
+
     def initialize(lines)
       @lines = lines
     end

data/lib/sentry/client.rb

@@ -4,6 +4,7 @@ require "sentry/transport"
 require "sentry/log_event"
 require "sentry/log_event_buffer"
 require "sentry/utils/uuid"
+require "sentry/utils/encoding_helper"
 
 module Sentry
   class Client
@@ -194,8 +195,17 @@ module Sentry
 
       attributes = options.reject { |k, _| k == :level || k == :severity || k == :origin }
       origin = options[:origin]
+      body = Utils::EncodingHelper.safe_utf_8_string(message)
 
-      LogEvent.new(level: level, body: message, attributes: attributes, origin: origin)
+      sanitized_attributes = attributes.transform_values do |value|
+        if value.is_a?(String)
+          Utils::EncodingHelper.safe_utf_8_string(value)
+        else
+          value
+        end
+      end
+
+      LogEvent.new(level: level, body: body, attributes: sanitized_attributes, origin: origin)
     end
 
     # Initializes an Event object with the given Transaction object.

data/lib/sentry/utils/encoding_helper.rb

@@ -3,6 +3,9 @@
 module Sentry
   module Utils
     module EncodingHelper
+      EMPTY_STRING = ""
+      MALFORMED_STRING = "<malformed-string>"
+
       def self.encode_to_utf_8(value)
         if value.encoding != Encoding::UTF_8 && value.respond_to?(:force_encoding)
           value = value.dup.force_encoding(Encoding::UTF_8)
@@ -17,6 +20,10 @@ module Sentry
 
         value.dup.force_encoding(Encoding::UTF_8).valid_encoding?
       end
+
+      def self.safe_utf_8_string(value)
+        valid_utf_8?(value) ? value : MALFORMED_STRING
+      end
     end
   end
 end

data/lib/sentry/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Sentry
-  VERSION = "6.1.0"
+  VERSION = "6.1.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sentry-ruby
 version: !ruby/object:Gem::Version
-  version: 6.1.0
+  version: 6.1.1
 platform: ruby
 authors:
 - Sentry Team
@@ -67,6 +67,7 @@ files:
 - lib/sentry/background_worker.rb
 - lib/sentry/backpressure_monitor.rb
 - lib/sentry/backtrace.rb
+- lib/sentry/backtrace/line.rb
 - lib/sentry/baggage.rb
 - lib/sentry/breadcrumb.rb
 - lib/sentry/breadcrumb/sentry_logger.rb
@@ -148,15 +149,15 @@ files:
 - lib/sentry/version.rb
 - sentry-ruby-core.gemspec
 - sentry-ruby.gemspec
-homepage: https://github.com/getsentry/sentry-ruby/tree/6.1.0/sentry-ruby
+homepage: https://github.com/getsentry/sentry-ruby/tree/6.1.1/sentry-ruby
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/getsentry/sentry-ruby/tree/6.1.0/sentry-ruby
-  source_code_uri: https://github.com/getsentry/sentry-ruby/tree/6.1.0/sentry-ruby
-  changelog_uri: https://github.com/getsentry/sentry-ruby/blob/6.1.0/CHANGELOG.md
+  homepage_uri: https://github.com/getsentry/sentry-ruby/tree/6.1.1/sentry-ruby
+  source_code_uri: https://github.com/getsentry/sentry-ruby/tree/6.1.1/sentry-ruby
+  changelog_uri: https://github.com/getsentry/sentry-ruby/blob/6.1.1/CHANGELOG.md
   bug_tracker_uri: https://github.com/getsentry/sentry-ruby/issues
-  documentation_uri: http://www.rubydoc.info/gems/sentry-ruby/6.1.0
+  documentation_uri: http://www.rubydoc.info/gems/sentry-ruby/6.1.1
 rdoc_options: []
 require_paths:
 - lib