sentry-ruby-core 4.6.2 → 4.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4d739cc418695f66cb3ff2d84276138d9ede10a4c56c5bb18f7b5e64d95f591b
-  data.tar.gz: bd81bdb989613b8a0a401f63a592723a5760bf3a96ec20698b69c3aca002120f
+  metadata.gz: '08bb1e6f6c55f8f9a206aabcb008ac4e8322652831108a0ec5145b69ed741c1d'
+  data.tar.gz: 7d699edbb8b0a1e05c44b0d039f2e9ea79cba7355961488f1bc9311e8a92cb14
 SHA512:
-  metadata.gz: b28d8c9ab0c76944dfdaf68298077ebedaffa054a2119b8490c4161090d2eef0981fcb8ee1494d68833539d98635b1baec11613ac7f5c8b8fce0bd7268d8c698
-  data.tar.gz: 75bbf542edf0d15e1f55684d90566deab151114b6750ad59b9eb224ad998449817987b4d255125fc3316dc99dfb0670ae39783a28df6e539e4e3b3c7c862d65a
+  metadata.gz: ff6528918de5664c632d44c48cc04536cd41537e7fb2e5bc372c5794834cc4450b9d6aff82ba6ba4ad0a822ee5f96bc74a165ae6c1164299585019a187c63aad
+  data.tar.gz: 9cf4dcecb8d81ec03048d22ffc75a0d4647b70a4bf037e9183ff794ef044f1ece661218a4ca22aef89cdbb4992361b1c9829a5aeeab0179430afc420c2d8a01f

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2020 st0012
+Copyright (c) 2020 getsentry
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/lib/sentry/breadcrumb/sentry_logger.rb

@@ -67,7 +67,7 @@ module Sentry
             type: severity >= 3 ? "error" : level
           )
 
-          Sentry.add_breadcrumb(crumb)
+          Sentry.add_breadcrumb(crumb, hint: { severity: severity })
         end
       end
 

data/lib/sentry/client.rb

@@ -26,7 +26,12 @@ module Sentry
     def capture_event(event, scope, hint = {})
       return unless configuration.sending_allowed?
 
-      scope.apply_to_event(event, hint)
+      event = scope.apply_to_event(event, hint)
+
+      if event.nil?
+        log_info("Discarded event because one of the event processors returned nil")
+        return
+      end
 
       if async_block = configuration.async
         dispatch_async_event(async_block, event, hint)
@@ -52,10 +57,10 @@ module Sentry
       end
     end
 
-    def event_from_message(message, hint = {})
+    def event_from_message(message, hint = {}, backtrace: nil)
       integration_meta = Sentry.integrations[hint[:integration]]
       event = Event.new(configuration: configuration, integration_meta: integration_meta, message: message)
-      event.add_threads_interface(backtrace: caller)
+      event.add_threads_interface(backtrace: backtrace || caller)
       event
     end
 

data/lib/sentry/configuration.rb

@@ -89,7 +89,7 @@ module Sentry
     # You should probably append to this rather than overwrite it.
     attr_accessor :excluded_exceptions
 
-    # Boolean to check nested exceptions when deciding if to exclude. Defaults to false
+    # Boolean to check nested exceptions when deciding if to exclude. Defaults to true
     attr_accessor :inspect_exception_causes_for_exclusion
     alias inspect_exception_causes_for_exclusion? inspect_exception_causes_for_exclusion
 
@@ -324,6 +324,15 @@ module Sentry
       log_error("Error detecting release", e, debug: debug)
     end
 
+    def csp_report_uri
+      if dsn && dsn.valid?
+        uri = dsn.csp_report_uri
+        uri += "&sentry_release=#{CGI.escape(release)}" if release && !release.empty?
+        uri += "&sentry_environment=#{CGI.escape(environment)}" if environment && !environment.empty?
+        uri
+      end
+    end
+
     private
 
     def excluded_exception?(incoming_exception)
@@ -405,7 +414,7 @@ module Sentry
     def sample_allowed?
       return true if sample_rate == 1.0
 
-      if Random::DEFAULT.rand >= sample_rate
+      if Random.rand >= sample_rate
         @errors << "Excluded by random sample"
         false
       else

data/lib/sentry/core_ext/object/deep_dup.rb

@@ -1,3 +1,5 @@
+return if Object.method_defined?(:deep_dup)
+
 require 'sentry/core_ext/object/duplicable'
 
 #########################################

data/lib/sentry/core_ext/object/duplicable.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+return if Object.method_defined?(:duplicable?)
 
 #########################################
 #  This file was copied from Rails 5.2  #

data/lib/sentry/dsn.rb

@@ -40,6 +40,10 @@ module Sentry
       server
     end
 
+    def csp_report_uri
+      "#{server}/api/#{project_id}/security/?sentry_key=#{public_key}"
+    end
+
     def envelope_endpoint
       "#{path}/api/#{project_id}/envelope/"
     end

data/lib/sentry/event.rb

@@ -9,7 +9,7 @@ require 'sentry/utils/request_id'
 
 module Sentry
   class Event
-    ATTRIBUTES = %i(
+    SERIALIZEABLE_ATTRIBUTES = %i(
       event_id level timestamp
       release environment server_name modules
       message user tags contexts extra
@@ -17,9 +17,13 @@ module Sentry
       platform sdk type
     )
 
+    WRITER_ATTRIBUTES = SERIALIZEABLE_ATTRIBUTES - %i(type timestamp level)
+
     MAX_MESSAGE_SIZE_IN_BYTES = 1024 * 8
 
-    attr_accessor(*ATTRIBUTES)
+    attr_writer(*WRITER_ATTRIBUTES)
+    attr_reader(*SERIALIZEABLE_ATTRIBUTES)
+
     attr_reader :configuration, :request, :exception, :threads
 
     def initialize(configuration:, integration_meta: nil, message: nil)
@@ -99,9 +103,6 @@ module Sentry
       end
     end
 
-    def type
-    end
-
     def to_hash
       data = serialize_attributes
       data[:breadcrumbs] = breadcrumbs.to_hash if breadcrumbs
@@ -139,7 +140,7 @@ module Sentry
     private
 
     def serialize_attributes
-      self.class::ATTRIBUTES.each_with_object({}) do |att, memo|
+      self.class::SERIALIZEABLE_ATTRIBUTES.each_with_object({}) do |att, memo|
         if value = public_send(att)
           memo[att] = value
         end

data/lib/sentry/hub.rb

@@ -108,7 +108,8 @@ module Sentry
 
       options[:hint] ||= {}
       options[:hint][:message] = message
-      event = current_client.event_from_message(message, options[:hint])
+      backtrace = options.delete(:backtrace)
+      event = current_client.event_from_message(message, options[:hint], backtrace: backtrace)
       capture_event(event, **options, &block)
     end
 
@@ -135,6 +136,8 @@ module Sentry
     end
 
     def add_breadcrumb(breadcrumb, hint: {})
+      return unless configuration.enabled_in_current_env?
+
       if before_breadcrumb = current_client.configuration.before_breadcrumb
         breadcrumb = before_breadcrumb.call(breadcrumb, hint)
       end

data/lib/sentry/interfaces/request.rb

@@ -57,7 +57,7 @@ module Sentry
         request.POST
       elsif request.body # JSON requests, etc
         data = request.body.read(MAX_BODY_LIMIT)
-        data = data.force_encoding(Encoding::UTF_8) if data.respond_to?(:force_encoding)
+        data = encode_to_utf_8(data.to_s)
         request.body.rewind
         data
       end
@@ -76,7 +76,8 @@ module Sentry
           # Rack stores headers as HTTP_WHAT_EVER, we need What-Ever
           key = key.sub(/^HTTP_/, "")
           key = key.split('_').map(&:capitalize).join('-')
-          memo[key] = value.to_s
+
+          memo[key] = encode_to_utf_8(value.to_s)
         rescue StandardError => e
           # Rails adds objects to the Rack env that can sometimes raise exceptions
           # when `to_s` is called.
@@ -87,6 +88,18 @@ module Sentry
       end
     end
 
+    def encode_to_utf_8(value)
+      if value.encoding != Encoding::UTF_8 && value.respond_to?(:force_encoding)
+        value = value.dup.force_encoding(Encoding::UTF_8)
+      end
+
+      if !value.valid_encoding?
+        value = value.scrub
+      end
+
+      value
+    end
+
     def is_skippable_header?(key)
       key.upcase != key || # lower-case envs aren't real http headers
         key == "HTTP_COOKIE" || # Cookies don't go here, they go somewhere else

data/lib/sentry/rake.rb

@@ -1,30 +1,31 @@
 require "rake"
 require "rake/task"
 
-module Rake
-  class Application
+module Sentry
+  module Rake
+    module Application
+      def display_error_message(ex)
+        Sentry.capture_exception(ex, hint: { background: false }) do |scope|
+          task_name = top_level_tasks.join(' ')
+          scope.set_transaction_name(task_name)
+          scope.set_tag("rake_task", task_name)
+        end if Sentry.initialized? && !Sentry.configuration.skip_rake_integration
 
-    alias orig_display_error_messsage display_error_message
-    def display_error_message(ex)
-      Sentry.capture_exception(ex, hint: { background: false }) do |scope|
-        task_name = top_level_tasks.join(' ')
-        scope.set_transaction_name(task_name)
-        scope.set_tag("rake_task", task_name)
-      end if Sentry.initialized? && !Sentry.configuration.skip_rake_integration
-
-      orig_display_error_messsage(ex)
+        super
+      end
     end
-  end
 
-  class Task
-    alias orig_execute execute
+    module Task
+      def execute(args=nil)
+        return super unless Sentry.initialized? && Sentry.get_current_hub
 
-    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
+        Sentry.get_current_hub.with_background_worker_disabled do
+          super
+        end
       end
     end
   end
 end
+
+Rake::Application.prepend(Sentry::Rake::Application)
+Rake::Task.prepend(Sentry::Rake::Task)

data/lib/sentry/scope.rb

@@ -23,6 +23,7 @@ module Sentry
       event.user = user.merge(event.user)
       event.extra = extra.merge(event.extra)
       event.contexts = contexts.merge(event.contexts)
+      event.transaction = transaction_name if transaction_name
 
       if span
         event.contexts[:trace] = span.get_trace_context
@@ -30,7 +31,6 @@ module Sentry
 
       event.fingerprint = fingerprint
       event.level = level
-      event.transaction = transaction_names.last
       event.breadcrumbs = breadcrumbs
       event.rack_env = rack_env if rack_env
 

data/lib/sentry/transaction_event.rb

@@ -4,22 +4,27 @@ module Sentry
   class TransactionEvent < Event
     TYPE = "transaction"
 
-    ATTRIBUTES = %i(
+    SERIALIZEABLE_ATTRIBUTES = %i(
       event_id level timestamp start_timestamp
       release environment server_name modules
       user tags contexts extra
       transaction platform sdk type
     )
 
-    attr_accessor(*ATTRIBUTES)
+    WRITER_ATTRIBUTES = SERIALIZEABLE_ATTRIBUTES - %i(type timestamp start_timestamp level)
+
+    attr_writer(*WRITER_ATTRIBUTES)
+    attr_reader(*SERIALIZEABLE_ATTRIBUTES)
+
     attr_accessor :spans
 
-    def start_timestamp=(time)
-      @start_timestamp = time.is_a?(Time) ? time.to_f : time
+    def initialize(configuration:, integration_meta: nil, message: nil)
+      super
+      @type = TYPE
     end
 
-    def type
-      TYPE
+    def start_timestamp=(time)
+      @start_timestamp = time.is_a?(Time) ? time.to_f : time
     end
 
     def to_hash

data/lib/sentry/transport/configuration.rb

@@ -2,7 +2,8 @@ module Sentry
   class Transport
     class Configuration
       attr_accessor :timeout, :open_timeout, :proxy, :ssl, :ssl_ca_file, :ssl_verification, :http_adapter, :faraday_builder,
-        :transport_class, :encoding
+        :encoding
+      attr_reader :transport_class
 
       def initialize
         @ssl_verification = true

data/lib/sentry/version.rb

@@ -1,3 +1,3 @@
 module Sentry
-  VERSION = "4.6.2"
+  VERSION = "4.7.0"
 end

data/lib/sentry-ruby.rb

@@ -36,15 +36,27 @@ module Sentry
 
   THREAD_LOCAL = :sentry_hub
 
-  def self.sdk_meta
-    META
-  end
+  class << self
+    attr_accessor :background_worker
 
-  def self.utc_now
-    Time.now.utc
-  end
+    ##### Patch Registration #####
+    #
+    def register_patch(&block)
+      registered_patches << block
+    end
 
-  class << self
+    def apply_patches(config)
+      registered_patches.each do |patch|
+        patch.call(config)
+      end
+    end
+
+    def registered_patches
+      @registered_patches ||= []
+    end
+
+    ##### Integrations #####
+    #
     # Returns a hash that contains all the integrations that have been registered to the main SDK.
     def integrations
       @integrations ||= {}
@@ -55,32 +67,16 @@ module Sentry
       meta = { name: "sentry.ruby.#{name}", version: version }.freeze
       integrations[name.to_s] = meta
     end
-  end
 
-  class << self
+    ##### Method Delegation #####
+    #
     extend Forwardable
 
     def_delegators :get_current_client, :configuration, :send_event
     def_delegators :get_current_scope, :set_tags, :set_extras, :set_user, :set_context
 
-    attr_accessor :background_worker
-
-    @@registered_patches = []
-
-    def register_patch(&block)
-      registered_patches << block
-    end
-
-    def apply_patches(config)
-      registered_patches.each do |patch|
-        patch.call(config)
-      end
-    end
-
-    def registered_patches
-      @@registered_patches
-    end
-
+    ##### Main APIs #####
+    #
     def init(&block)
       config = Configuration.new
       yield(config) if block_given?
@@ -94,14 +90,26 @@ module Sentry
       @background_worker = Sentry::BackgroundWorker.new(config)
     end
 
+    # Returns an uri for security policy reporting that's generated from the given DSN
+    # (To learn more about security policy reporting: https://docs.sentry.io/product/security-policy-reporting/)
+    #
+    # It returns nil if
+    #
+    # 1. The SDK is not initialized yet.
+    # 2. The DSN is not provided or is invalid.
+    def csp_report_uri
+      return unless initialized?
+      configuration.csp_report_uri
+    end
+
     # Returns the main thread's active hub.
     def get_main_hub
       @main_hub
     end
 
     # Takes an instance of Sentry::Breadcrumb and stores it to the current active scope.
-    def add_breadcrumb(breadcrumb)
-      get_current_hub&.add_breadcrumb(breadcrumb)
+    def add_breadcrumb(breadcrumb, **options)
+      get_current_hub&.add_breadcrumb(breadcrumb, **options)
     end
 
     # Returns the current active hub.
@@ -193,6 +201,9 @@ module Sentry
       get_current_hub&.last_event_id
     end
 
+
+    ##### Helpers #####
+    #
     def sys_command(command)
       result = `#{command} 2>&1` rescue nil
       return if result.nil? || result.empty? || ($CHILD_STATUS && $CHILD_STATUS.exitstatus != 0)
@@ -207,6 +218,14 @@ module Sentry
     def logger
       configuration.logger
     end
+
+    def sdk_meta
+      META
+    end
+
+    def utc_now
+      Time.now.utc
+    end
   end
 end
 

data/sentry-ruby-core.gemspec

@@ -6,7 +6,7 @@ Gem::Specification.new do |spec|
   spec.authors = ["Sentry Team"]
   spec.description = spec.summary = "A gem that provides a client interface for the Sentry error logger"
   spec.email = "accounts@sentry.io"
-  spec.license = 'Apache-2.0'
+  spec.license = 'MIT'
   spec.homepage = "https://github.com/getsentry/sentry-ruby"
 
   spec.platform = Gem::Platform::RUBY

data/sentry-ruby.gemspec

@@ -6,7 +6,7 @@ Gem::Specification.new do |spec|
   spec.authors = ["Sentry Team"]
   spec.description = spec.summary = "A gem that provides a client interface for the Sentry error logger"
   spec.email = "accounts@sentry.io"
-  spec.license = 'Apache-2.0'
+  spec.license = 'MIT'
   spec.homepage = "https://github.com/getsentry/sentry-ruby"
 
   spec.platform = Gem::Platform::RUBY

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sentry-ruby-core
 version: !ruby/object:Gem::Version
-  version: 4.6.2
+  version: 4.7.0
 platform: ruby
 authors:
 - Sentry Team
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-07-23 00:00:00.000000000 Z
+date: 2021-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -103,7 +103,7 @@ files:
 - sentry-ruby.gemspec
 homepage: https://github.com/getsentry/sentry-ruby
 licenses:
-- Apache-2.0
+- MIT
 metadata:
   homepage_uri: https://github.com/getsentry/sentry-ruby
   source_code_uri: https://github.com/getsentry/sentry-ruby