sentry-ruby-core 4.6.4 → 4.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 442dc8b92f82ac1873cc066b8188d49ad4673425c2833416b5262c8076e4a13d
-  data.tar.gz: 1c7b5d1d49ebc37da4cd3b524b50e0d50b1e7152cbbeb8f712603a57ceeac53c
+  metadata.gz: a52a74b95eb5a763ce6d21da44dfc2c1cbbdd733c2f140888fd3d7645e4cf890
+  data.tar.gz: e275f2ecd44578e4e604fed42b104e0c191137199ea61572191295def1526c58
 SHA512:
-  metadata.gz: e5f3aa0e7950fff974c056ac389218d68677804b590e1d94bac250070130630915d72905df42d88d6beb434912f893c3a86a6e0a734c8f6b7e6b91ae44d813e2
-  data.tar.gz: d5f973ca005648a658c71e2c2e2a336bf68f7511b856147b4f8bcacd6234bf6d950e37d97af422dfc0c730f75e57e0e7a1ec41e2c819ed6cb222a811494d55e1
+  metadata.gz: 267c6dc30e8e43f2b051932165d5ce8631ba650285552e49ed810c572b984b7f87d29115eedbae0ab8283f63cbc66fc205ce9b6273fae477787e9163dad13297
+  data.tar.gz: 989f509506d4dce0b1d45c52bc4efc7c6f909f79770703aa3ef5e8b9c00a10e8ee7776cbbce7cb10dc83a678adec9fb0be86b483f87330ce46be4044a888980d

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2020 st0012
+Copyright (c) 2020 Sentry
 
 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

@@ -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)
@@ -421,7 +430,7 @@ module Sentry
     end
 
     def environment_from_env
-      ENV['SENTRY_CURRENT_ENV'] || ENV['SENTRY_ENVIRONMENT'] || ENV['RAILS_ENV'] || ENV['RACK_ENV'] || 'default'
+      ENV['SENTRY_CURRENT_ENV'] || ENV['SENTRY_ENVIRONMENT'] || ENV['RAILS_ENV'] || ENV['RACK_ENV'] || 'development'
     end
 
     def server_name_from_env

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/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/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/version.rb

@@ -1,3 +1,3 @@
 module Sentry
-  VERSION = "4.6.4"
+  VERSION = "4.7.2"
 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.4
+  version: 4.7.2
 platform: ruby
 authors:
 - Sentry Team
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-07-29 00:00:00.000000000 Z
+date: 2021-09-09 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