sentry-ruby-core 4.1.5.pre.beta.0

data/lib/sentry/transaction_event.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Sentry
+  class TransactionEvent < Event
+    ATTRIBUTES = %i(
+      event_id level timestamp start_timestamp
+      release environment server_name modules
+      user tags contexts extra
+      transaction platform sdk type
+    )
+
+    attr_accessor(*ATTRIBUTES)
+    attr_accessor :spans
+
+    def start_timestamp=(time)
+      @start_timestamp = time.is_a?(Time) ? time.to_f : time
+    end
+
+    def type
+      "transaction"
+    end
+
+    def to_hash
+      data = super
+      data[:spans] = @spans.map(&:to_hash) if @spans
+      data
+    end
+  end
+end

data/lib/sentry/transport.rb

@@ -0,0 +1,88 @@
+require "json"
+require "base64"
+
+module Sentry
+  class Transport
+    PROTOCOL_VERSION = '5'
+    USER_AGENT = "sentry-ruby/#{Sentry::VERSION}"
+
+    attr_accessor :configuration
+
+    def initialize(configuration)
+      @configuration = configuration
+      @transport_configuration = configuration.transport
+      @dsn = configuration.dsn
+    end
+
+    def send_data(data, options = {})
+      raise NotImplementedError
+    end
+
+    def send_event(event)
+      unless configuration.sending_allowed?
+        configuration.logger.debug(LOGGER_PROGNAME) { "Event not sent: #{configuration.error_messages}" }
+        return
+      end
+
+      encoded_data = prepare_encoded_event(event)
+
+      return nil unless encoded_data
+
+      send_data(encoded_data)
+
+      event
+    rescue => e
+      failed_for_exception(e, event)
+      nil
+    end
+
+    def generate_auth_header
+      now = Sentry.utc_now.to_i
+      fields = {
+        'sentry_version' => PROTOCOL_VERSION,
+        'sentry_client' => USER_AGENT,
+        'sentry_timestamp' => now,
+        'sentry_key' => @dsn.public_key
+      }
+      fields['sentry_secret'] = @dsn.secret_key if @dsn.secret_key
+      'Sentry ' + fields.map { |key, value| "#{key}=#{value}" }.join(', ')
+    end
+
+    def encode(event_hash)
+      event_id = event_hash[:event_id] || event_hash['event_id']
+      event_type = event_hash[:type] || event_hash['type']
+
+      envelope = <<~ENVELOPE
+        {"event_id":"#{event_id}","dsn":"#{configuration.dsn.to_s}","sdk":#{Sentry.sdk_meta.to_json},"sent_at":"#{Sentry.utc_now.iso8601}"}
+        {"type":"#{event_type}","content_type":"application/json"}
+        #{JSON.generate(event_hash)}
+      ENVELOPE
+
+      envelope
+    end
+
+    private
+
+    def prepare_encoded_event(event)
+      # Convert to hash
+      event_hash = event.to_hash
+
+      event_id = event_hash[:event_id] || event_hash["event_id"]
+      event_type = event_hash[:type] || event_hash["type"]
+      configuration.logger.info(LOGGER_PROGNAME) { "Sending #{event_type} #{event_id} to Sentry" }
+      encode(event_hash)
+    end
+
+    def failed_for_exception(e, event)
+      configuration.logger.warn(LOGGER_PROGNAME) { "Unable to record event with remote Sentry server (#{e.class} - #{e.message}):\n#{e.backtrace[0..10].join("\n")}" }
+      log_not_sending(event)
+    end
+
+    def log_not_sending(event)
+      configuration.logger.warn(LOGGER_PROGNAME) { "Failed to submit event. Unreported Event: #{Event.get_log_message(event.to_hash)}" }
+    end
+  end
+end
+
+require "sentry/transport/dummy_transport"
+require "sentry/transport/http_transport"

data/lib/sentry/transport/configuration.rb

@@ -0,0 +1,21 @@
+module Sentry
+  class Transport
+    class Configuration
+      attr_accessor :timeout, :open_timeout, :proxy, :ssl, :ssl_ca_file, :ssl_verification, :http_adapter, :faraday_builder, :transport_class
+
+      def initialize
+        @ssl_verification = true
+        @open_timeout = 1
+        @timeout = 2
+      end
+
+      def transport_class=(klass)
+        unless klass.is_a?(Class)
+          raise Sentry::Error.new("config.transport.transport_class must a class. got: #{klass.class}")
+        end
+
+        @transport_class = klass
+      end
+    end
+  end
+end

data/lib/sentry/transport/dummy_transport.rb

@@ -0,0 +1,14 @@
+module Sentry
+  class DummyTransport < Transport
+    attr_accessor :events
+
+    def initialize(*)
+      super
+      @events = []
+    end
+
+    def send_event(event)
+      @events << event
+    end
+  end
+end

data/lib/sentry/transport/http_transport.rb

@@ -0,0 +1,62 @@
+require 'faraday'
+
+module Sentry
+  class HTTPTransport < Transport
+    CONTENT_TYPE = 'application/json'
+    attr_reader :conn, :adapter
+
+    def initialize(*args)
+      super
+      @adapter = @transport_configuration.http_adapter || Faraday.default_adapter
+      @conn = set_conn
+      @endpoint = @dsn.envelope_endpoint
+    end
+
+    def send_data(data)
+      conn.post @endpoint do |req|
+        req.headers['Content-Type'] = CONTENT_TYPE
+        req.headers['X-Sentry-Auth'] = generate_auth_header
+        req.body = data
+      end
+    rescue Faraday::Error => e
+      error_info = e.message
+
+      if e.response
+        error_info += "\nbody: #{e.response[:body]}"
+        error_info += " Error in headers is: #{e.response[:headers]['x-sentry-error']}" if e.response[:headers]['x-sentry-error']
+      end
+
+      raise Sentry::Error, error_info
+    end
+
+    private
+
+    def set_conn
+      server = @dsn.server
+
+      configuration.logger.debug(LOGGER_PROGNAME) { "Sentry HTTP Transport connecting to #{server}" }
+
+      Faraday.new(server, :ssl => ssl_configuration, :proxy => @transport_configuration.proxy) do |builder|
+        @transport_configuration.faraday_builder&.call(builder)
+        builder.response :raise_error
+        builder.options.merge! faraday_opts
+        builder.headers[:user_agent] = "sentry-ruby/#{Sentry::VERSION}"
+        builder.adapter(*adapter)
+      end
+    end
+
+    # TODO: deprecate and replace where possible w/Faraday Builder
+    def faraday_opts
+      [:timeout, :open_timeout].each_with_object({}) do |opt, memo|
+        memo[opt] = @transport_configuration.public_send(opt) if @transport_configuration.public_send(opt)
+      end
+    end
+
+    def ssl_configuration
+      (@transport_configuration.ssl || {}).merge(
+        :verify => @transport_configuration.ssl_verification,
+        :ca_file => @transport_configuration.ssl_ca_file
+      )
+    end
+  end
+end

data/lib/sentry/utils/argument_checking_helper.rb

@@ -0,0 +1,11 @@
+module Sentry
+  module ArgumentCheckingHelper
+    private
+
+    def check_argument_type!(argument, expected_type)
+      unless argument.is_a?(expected_type)
+        raise ArgumentError, "expect the argument to be a #{expected_type}, got #{argument.class} (#{argument.inspect})"
+      end
+    end
+  end
+end

data/lib/sentry/utils/exception_cause_chain.rb

@@ -0,0 +1,20 @@
+module Sentry
+  module Utils
+    module ExceptionCauseChain
+      def self.exception_to_array(exception)
+        if exception.respond_to?(:cause) && exception.cause
+          exceptions = [exception]
+          while exception.cause
+            exception = exception.cause
+            break if exceptions.any? { |e| e.object_id == exception.object_id }
+
+            exceptions << exception
+          end
+          exceptions
+        else
+          [exception]
+        end
+      end
+    end
+  end
+end

data/lib/sentry/utils/real_ip.rb

@@ -0,0 +1,70 @@
+require 'ipaddr'
+
+# Based on ActionDispatch::RemoteIp. All security-related precautions from that
+# middleware have been removed, because the Event IP just needs to be accurate,
+# and spoofing an IP here only makes data inaccurate, not insecure. Don't re-use
+# this module if you have to *trust* the IP address.
+module Sentry
+  module Utils
+    class RealIp
+      LOCAL_ADDRESSES = [
+        "127.0.0.1",      # localhost IPv4
+        "::1",            # localhost IPv6
+        "fc00::/7",       # private IPv6 range fc00::/7
+        "10.0.0.0/8",     # private IPv4 range 10.x.x.x
+        "172.16.0.0/12",  # private IPv4 range 172.16.0.0 .. 172.31.255.255
+        "192.168.0.0/16" # private IPv4 range 192.168.x.x
+      ].map { |proxy| IPAddr.new(proxy) }
+
+      attr_reader :ip
+
+      def initialize(
+        remote_addr: nil,
+        client_ip: nil,
+        real_ip: nil,
+        forwarded_for: nil
+      )
+        @remote_addr = remote_addr
+        @client_ip = client_ip
+        @real_ip = real_ip
+        @forwarded_for = forwarded_for
+      end
+
+      def calculate_ip
+        # CGI environment variable set by Rack
+        remote_addr = ips_from(@remote_addr).last
+
+        # Could be a CSV list and/or repeated headers that were concatenated.
+        client_ips    = ips_from(@client_ip)
+        real_ips      = ips_from(@real_ip)
+        forwarded_ips = ips_from(@forwarded_for)
+
+        ips = [client_ips, real_ips, forwarded_ips, remote_addr].flatten.compact
+
+        # If every single IP option is in the trusted list, just return REMOTE_ADDR
+        @ip = filter_local_addresses(ips).first || remote_addr
+      end
+
+      protected
+
+      def ips_from(header)
+        # Split the comma-separated list into an array of strings
+        ips = header ? header.strip.split(/[,\s]+/) : []
+        ips.select do |ip|
+          begin
+            # Only return IPs that are valid according to the IPAddr#new method
+            range = IPAddr.new(ip).to_range
+            # we want to make sure nobody is sneaking a netmask in
+            range.begin == range.end
+          rescue ArgumentError
+            nil
+          end
+        end
+      end
+
+      def filter_local_addresses(ips)
+        ips.reject { |ip| LOCAL_ADDRESSES.any? { |proxy| proxy === ip } }
+      end
+    end
+  end
+end

data/lib/sentry/utils/request_id.rb

@@ -0,0 +1,16 @@
+module Sentry
+  module Utils
+    module RequestId
+      REQUEST_ID_HEADERS = %w(action_dispatch.request_id HTTP_X_REQUEST_ID).freeze
+
+      # Request ID based on ActionDispatch::RequestId
+      def self.read_from(env)
+        REQUEST_ID_HEADERS.each do |key|
+          request_id = env[key]
+          return request_id if request_id
+        end
+        nil
+      end
+    end
+  end
+end

data/lib/sentry/version.rb

@@ -0,0 +1,3 @@
+module Sentry
+  VERSION = "4.1.5-beta.0"
+end

data/sentry-ruby-core.gemspec

@@ -0,0 +1,27 @@
+require_relative "lib/sentry/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "sentry-ruby-core"
+  spec.version       = Sentry::VERSION
+  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.homepage = "https://github.com/getsentry/sentry-ruby"
+
+  spec.platform = Gem::Platform::RUBY
+  spec.required_ruby_version = '>= 2.4'
+  spec.extra_rdoc_files = ["README.md", "LICENSE.txt"]
+  spec.files = `git ls-files | grep -Ev '^(spec|benchmarks|examples)'`.split("\n")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/master/CHANGELOG.md"
+
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "faraday"
+  spec.add_dependency "concurrent-ruby"
+end

data/sentry-ruby.gemspec

@@ -0,0 +1,23 @@
+require_relative "lib/sentry/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "sentry-ruby"
+  spec.version       = Sentry::VERSION
+  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.homepage = "https://github.com/getsentry/sentry-ruby"
+
+  spec.platform = Gem::Platform::RUBY
+  spec.required_ruby_version = '>= 2.4'
+  spec.extra_rdoc_files = ["README.md", "LICENSE.txt"]
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/master/CHANGELOG.md"
+
+  spec.add_dependency "sentry-ruby-core", Sentry::VERSION
+  spec.add_dependency "faraday", ">= 1.0"
+  spec.add_dependency "concurrent-ruby", '~> 1.0', '>= 1.0.2'
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: sentry-ruby-core
+version: !ruby/object:Gem::Version
+  version: 4.1.5.pre.beta.0
+platform: ruby
+authors:
+- Sentry Team
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-01-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A gem that provides a client interface for the Sentry error logger
+email: accounts@sentry.io
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- LICENSE.txt
+files:
+- ".craft.yml"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/sentry-ruby.rb
+- lib/sentry/background_worker.rb
+- lib/sentry/backtrace.rb
+- lib/sentry/benchmarks/benchmark_transport.rb
+- lib/sentry/breadcrumb.rb
+- lib/sentry/breadcrumb/sentry_logger.rb
+- lib/sentry/breadcrumb_buffer.rb
+- lib/sentry/client.rb
+- lib/sentry/configuration.rb
+- lib/sentry/core_ext/object/deep_dup.rb
+- lib/sentry/core_ext/object/duplicable.rb
+- lib/sentry/dsn.rb
+- lib/sentry/event.rb
+- lib/sentry/hub.rb
+- lib/sentry/integrable.rb
+- lib/sentry/interface.rb
+- lib/sentry/interfaces/exception.rb
+- lib/sentry/interfaces/request.rb
+- lib/sentry/interfaces/single_exception.rb
+- lib/sentry/interfaces/stacktrace.rb
+- lib/sentry/linecache.rb
+- lib/sentry/logger.rb
+- lib/sentry/rack.rb
+- lib/sentry/rack/capture_exceptions.rb
+- lib/sentry/rack/deprecations.rb
+- lib/sentry/rake.rb
+- lib/sentry/scope.rb
+- lib/sentry/span.rb
+- lib/sentry/transaction.rb
+- lib/sentry/transaction_event.rb
+- lib/sentry/transport.rb
+- lib/sentry/transport/configuration.rb
+- lib/sentry/transport/dummy_transport.rb
+- lib/sentry/transport/http_transport.rb
+- lib/sentry/utils/argument_checking_helper.rb
+- lib/sentry/utils/exception_cause_chain.rb
+- lib/sentry/utils/real_ip.rb
+- lib/sentry/utils/request_id.rb
+- lib/sentry/version.rb
+- sentry-ruby-core.gemspec
+- sentry-ruby.gemspec
+homepage: https://github.com/getsentry/sentry-ruby
+licenses:
+- Apache-2.0
+metadata:
+  homepage_uri: https://github.com/getsentry/sentry-ruby
+  source_code_uri: https://github.com/getsentry/sentry-ruby
+  changelog_uri: https://github.com/getsentry/sentry-ruby/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.4'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: A gem that provides a client interface for the Sentry error logger
+test_files: []