sentry-raven 2.0.2 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e464bc91ea975824329dfd86c13edf2d9e75e9cb
-  data.tar.gz: 31719bdb63d32973a5ea442db84138ad76b84a81
+  metadata.gz: ca26b5db2081fdbbdc2d2de7bbd580f1efcbd3f2
+  data.tar.gz: b95c0447aa43feb90d16585803a8815e218390c4
 SHA512:
-  metadata.gz: 9f1739d86ea78f779bfeccfefe10915cc90239478b034f801c0e4cfe7c00c56751c51daaf6041e4e62ee82f45ab281087c18cf30a6f9234b67958c1181935c0e
-  data.tar.gz: 04e10bb6c9edf0224e369ff53fc811f133fec59a5a354ac83f70a0ef48ccad6e379b22bc10926d56e0bdef4109b64bd8591a9abe5030ca5bccf8505f14453fdc
+  metadata.gz: 49d734c72e306caf5e6a760ee9e76e787eb865f33542929b43ee244b7596607b7f9a13b1d77f531d25de4d09a04d15ca87fab96438379a4fc621b17f8e9c0959
+  data.tar.gz: 9c299e76d4f1081225fd7950a09434564bc4a805bc77673efe2a501af4446297c876bc68edd88267d429d35fa1ac20f24903c0193393b7ec0e85e07f3c9b36c5

data/lib/raven/base.rb

@@ -90,5 +90,13 @@ module Raven
         opts[:to].send(:include, opts[:from].const_get("Old" + module_name))
       end
     end
+
+    def sys_command(unix_command, win_command = nil)
+      unix_result = `#{unix_command} 2>&1` rescue nil # redirect stderr to stdout
+      return unix_result if unix_result != "" && unix_result
+      return if win_command.nil?
+      win_result = `#{win_command}` rescue nil
+      win_result != "" && win_result
+    end
   end
 end

data/lib/raven/configuration.rb

@@ -267,15 +267,24 @@ module Raven
     end
 
     def detect_release
-      detect_release_from_heroku ||
+      detect_release_from_git ||
         detect_release_from_capistrano ||
-        detect_release_from_git
+        detect_release_from_heroku
     end
 
     private
 
     def detect_release_from_heroku
-      ENV['HEROKU_SLUG_COMMIT']
+      sys_dyno_info = File.read("/etc/heroku/dyno").strip if File.directory?("/etc/heroku") rescue nil
+      return unless sys_dyno_info
+
+      # being overly cautious, because if we raise an error Raven won't start
+      begin
+        hash = JSON.parse(sys_dyno_info)
+        hash && hash["release"] && hash["release"]["commit"]
+      rescue JSON::JSONError
+        Raven.logger.error "Cannot parse Heroku JSON: #{sys_dyno_info}"
+      end
     end
 
     def detect_release_from_capistrano

data/lib/raven/context.rb

@@ -1,3 +1,5 @@
+require 'rbconfig'
+
 module Raven
   class Context
     def self.current
@@ -8,14 +10,33 @@ module Raven
       Thread.current[:sentry_context] = nil
     end
 
-    attr_reader :extra, :tags
-    attr_accessor :rack_env, :user
+    attr_accessor :extra, :os, :rack_env, :runtime, :tags, :user
 
     def initialize
-      @extra = {}
-      @tags = {}
-      @user = {}
-      @rack_env = nil
+      self.extra = {}
+      self.os = self.class.os_context
+      self.rack_env = nil
+      self.runtime = self.class.runtime_context
+      self.tags = {}
+      self.user = {}
+    end
+
+    class << self
+      def os_context
+        @os_context ||= {
+          "name" => Raven.sys_command("uname -s") || RbConfig::CONFIG["host_os"],
+          "version" => Raven.sys_command("uname -v"),
+          "build" => Raven.sys_command("uname -r"),
+          "kernel_version" => Raven.sys_command("uname -a", "ver")
+        }
+      end
+
+      def runtime_context
+        @runtime_context ||= {
+          "name" => RbConfig::CONFIG["ruby_install_name"],
+          "version" => Raven.sys_command("ruby -v")
+        }
+      end
     end
   end
 end

data/lib/raven/event.rb

@@ -21,11 +21,12 @@ module Raven
     BACKTRACE_RE = /^(.+?):(\d+)(?::in `(.+?)')?$/
 
     PLATFORM = "ruby".freeze
+    SDK = { "name" => "sentry-raven", "version" => Raven::VERSION }.freeze
 
-    attr_reader :id
-    attr_accessor :project, :message, :timestamp, :time_spent, :level, :logger,
-                  :culprit, :server_name, :release, :modules, :extra, :tags, :context, :configuration,
-                  :checksum, :fingerprint, :environment
+    attr_accessor :id, :timestamp, :time_spent, :level, :logger,
+                  :culprit, :server_name, :release, :modules, :extra, :tags,
+                  :context, :configuration, :checksum, :fingerprint, :environment,
+                  :os, :runtime, :breadcrumbs, :user, :backtrace
 
     def initialize(init = {})
       @configuration = Raven.configuration
@@ -33,8 +34,6 @@ module Raven
       @breadcrumbs   = Raven.breadcrumbs
       @context       = Raven.context
       @id            = SecureRandom.uuid.delete("-")
-      @project       = nil
-      @message       = nil
       @timestamp     = Time.now.utc
       @time_spent    = nil
       @level         = :error
@@ -43,9 +42,11 @@ module Raven
       @server_name   = @configuration.server_name
       @release       = @configuration.release
       @modules       = list_gem_specs if @configuration.send_modules
-      @user          = {}
-      @extra         = {}
-      @tags          = {}
+      @user          = {} # TODO: contexts
+      @extra         = {} # TODO: contexts
+      @os            = {} # TODO: contexts
+      @runtime       = {} # TODO: contexts
+      @tags          = {} # TODO: contexts
       @checksum      = nil
       @fingerprint   = nil
       @environment   = @configuration.current_environment
@@ -58,15 +59,17 @@ module Raven
         end
       end
 
-      if @context.rack_env
+      if @context.rack_env # TODO: contexts
         @context.user[:ip_address] = calculate_real_ip_from_rack
       end
 
-      init.each_pair { |key, val| instance_variable_set('@' + key.to_s, val) }
+      init.each_pair { |key, val| public_send(key.to_s + "=", val) }
 
-      @user = @context.user.merge(@user)
-      @extra = @context.extra.merge(@extra)
-      @tags = @configuration.tags.merge(@context.tags).merge(@tags)
+      @user = @context.user.merge(@user) # TODO: contexts
+      @extra = @context.extra.merge(@extra) # TODO: contexts
+      @tags = @configuration.tags.merge(@context.tags).merge(@tags) # TODO: contexts
+      @os = @context.os # TODO: contexts
+      @runtime = @context.runtime # TODO: contexts
 
       # Some type coercion
       @timestamp  = @timestamp.strftime('%Y-%m-%dT%H:%M:%S') if @timestamp.is_a?(Time)
@@ -74,6 +77,18 @@ module Raven
       @level      = LOG_LEVELS[@level.to_s.downcase] if @level.is_a?(String) || @level.is_a?(Symbol)
     end
 
+    def message
+      @interfaces[:logentry] && @interfaces[:logentry].unformatted_message
+    end
+
+    def message=(args)
+      message, params = *args
+      interface(:message) do |int|
+        int.message = message
+        int.params = params
+      end
+    end
+
     class << self
       def from_exception(exc, options = {}, &block)
         exception_context = get_exception_context(exc) || {}
@@ -107,11 +122,8 @@ module Raven
 
         new(options) do |evt|
           evt.configuration = configuration
-          evt.message = message
           evt.level = options[:level] || :error
-          evt.interface :message do |int|
-            int.message = message
-          end
+          evt.message = message, options[:message_params] || []
           if options[:backtrace]
             evt.interface(:stacktrace) do |int|
               stacktrace_interface_from(int, evt, options[:backtrace])
@@ -196,10 +208,10 @@ module Raven
     end
 
     def interface(name, value = nil, &block)
-      int = Raven.find_interface(name)
+      int = Interface.registered[name]
       raise(Error, "Unknown interface: #{name}") unless int
-      @interfaces[int.name] = int.new(value, &block) if value || block
-      @interfaces[int.name]
+      @interfaces[int.sentry_alias] = int.new(value, &block) if value || block
+      @interfaces[int.sentry_alias]
     end
 
     def [](key)
@@ -213,13 +225,17 @@ module Raven
     def to_hash
       data = {
         :event_id => @id,
-        :message => @message,
         :timestamp => @timestamp,
         :time_spent => @time_spent,
         :level => @level,
-        :project => @project,
-        :platform => PLATFORM
+        :platform => PLATFORM,
+        :sdk => SDK,
+        :contexts => {
+          :os => @os,
+          :runtime => @runtime
+        }
       }
+
       data[:logger] = @logger if @logger
       data[:culprit] = @culprit if @culprit
       data[:server_name] = @server_name if @server_name
@@ -232,9 +248,11 @@ module Raven
       data[:user] = @user if @user
       data[:breadcrumbs] = @breadcrumbs.to_hash unless @breadcrumbs.empty?
       data[:checksum] = @checksum if @checksum
+
       @interfaces.each_pair do |name, int_data|
         data[name.to_sym] = int_data.to_hash
       end
+      data[:message] = message
       data
     end
 

data/lib/raven/integrations/sidekiq.rb

@@ -3,56 +3,62 @@ require 'sidekiq'
 
 module Raven
   class Sidekiq
-    def call(_worker, msg, _queue)
-      started_at = Time.now
-      yield
-    rescue Exception => ex
-      Raven.capture_exception(ex, :extra => { :sidekiq => msg },
-                                  :time_spent => Time.now - started_at)
-      raise
+    ACTIVEJOB_RESERVED_PREFIX = "_aj_".freeze
+
+    def call(ex, context)
+      context = filter_context(context)
+      Raven.capture_exception(
+        ex,
+        :message => ex.message,
+        :extra => { :sidekiq => context },
+        :culprit => culprit_from_context(context)
+      )
     ensure
       Context.clear!
       BreadcrumbBuffer.clear!
     end
-  end
-end
 
-if Sidekiq::VERSION < '3'
-  # old behavior
-  ::Sidekiq.configure_server do |config|
-    config.server_middleware do |chain|
-      chain.add ::Raven::Sidekiq
+    private
+
+    # Once an ActiveJob is queued, ActiveRecord references get serialized into
+    # some internal reserved keys, such as _aj_globalid.
+    #
+    # The problem is, if this job in turn gets queued back into ActiveJob with
+    # these magic reserved keys, ActiveJob will throw up and error. We want to
+    # capture these and mutate the keys so we can sanely report it.
+    def filter_context(context)
+      case context
+      when Array
+        context.map { |arg| filter_context(arg) }
+      when Hash
+        Hash[context.map { |key, value| filter_context_hash(key, value) }]
+      else
+        context
+      end
     end
-  end
-else
-  Sidekiq.configure_server do |config|
-    config.error_handlers << proc do |ex, context|
-      Raven.capture_exception(ex, :extra => {
-                                :sidekiq => filter_context(context)
-                              })
+
+    def filter_context_hash(key, value)
+      (key = key[3..-1]) if key [0..3] == ACTIVEJOB_RESERVED_PREFIX
+      [key, filter_context(value)]
     end
-  end
-end
 
-def filter_context(context)
-  case context
-  when Array
-    context.map { |arg| filter_context(arg) }
-  when Hash
-    Hash[context.map { |key, value| filter_context_hash(key, value) }]
-  else
-    context
+    # this will change in the future:
+    # https://github.com/mperham/sidekiq/pull/3161
+    def culprit_from_context(context)
+      classname = (context["class"] || (context["job"] && context["job"]["class"]))
+      if classname
+        "Sidekiq/#{classname}"
+      elsif context["event"]
+        "Sidekiq/#{context['event']}"
+      else
+        "Sidekiq"
+      end
+    end
   end
 end
 
-def filter_context_hash(key, value)
-  # Strip any `_aj` prefixes from keys.
-  # These keys come from an internal serialized object from ActiveJob.
-  # Internally, there are a subset of keys that ActiveJob references, but
-  # these are declared as private, and I don't think it's wise
-  # to keep chasing what this list is. But they all use a common prefix, so
-  # we want to strip this becuase ActiveJob will complain.
-  # e.g.: _aj_globalid -> _globalid
-  (key = key[3..-1]) if key [0..3] == "_aj_"
-  [key, filter_context(value)]
+if Sidekiq::VERSION > '3'
+  Sidekiq.configure_server do |config|
+    config.error_handlers << Raven::Sidekiq.new
+  end
 end

data/lib/raven/{interfaces.rb → interface.rb}

@@ -1,6 +1,4 @@
 module Raven
-  INTERFACES = {} # rubocop:disable Style/MutableConstant
-
   class Interface
     def initialize(attributes = nil)
       attributes.each do |attr, value|
@@ -10,23 +8,18 @@ module Raven
       yield self if block_given?
     end
 
-    def self.name(value = nil)
-      @interface_name ||= value
+    def self.inherited(klass)
+      name = klass.name.split("::").last.downcase.gsub("interface", "")
+      registered[name.to_sym] = klass
+      super
     end
 
-    def to_hash
-      Hash[instance_variables.map { |name| [name[1..-1].to_sym, instance_variable_get(name)] }]
+    def self.registered
+      @@registered ||= {} # rubocop:disable Style/ClassVars
     end
-  end
 
-  def self.register_interface(mapping)
-    mapping.each_pair do |key, klass|
-      INTERFACES[key.to_s] = klass
-      INTERFACES[klass.name] = klass
+    def to_hash
+      Hash[instance_variables.map { |name| [name[1..-1].to_sym, instance_variable_get(name)] }]
     end
   end
-
-  def self.find_interface(name)
-    INTERFACES[name.to_s]
-  end
 end

data/lib/raven/interfaces/exception.rb

@@ -1,16 +1,17 @@
-require 'raven/interfaces'
+require 'raven/interface'
 
 module Raven
   class ExceptionInterface < Interface
-    name 'exception'
     attr_accessor :values
 
+    def self.sentry_alias
+      :exception
+    end
+
     def to_hash(*args)
       data = super(*args)
       data[:values] = data[:values].map(&:to_hash) if data[:values]
       data
     end
   end
-
-  register_interface :exception => ExceptionInterface
 end

data/lib/raven/interfaces/http.rb

@@ -1,15 +1,8 @@
-require 'raven/interfaces'
+require 'raven/interface'
 
 module Raven
   class HttpInterface < Interface
-    name 'request'
-    attr_accessor :url
-    attr_accessor :method
-    attr_accessor :data
-    attr_accessor :query_string
-    attr_accessor :cookies
-    attr_accessor :headers
-    attr_accessor :env
+    attr_accessor :url, :method, :data, :query_string, :cookies, :headers, :env
 
     def initialize(*arguments)
       self.headers = {}
@@ -17,7 +10,9 @@ module Raven
       self.cookies = nil
       super(*arguments)
     end
-  end
 
-  register_interface :http => HttpInterface
+    def self.sentry_alias
+      :request
+    end
+  end
 end

data/lib/raven/interfaces/message.rb

@@ -1,16 +1,20 @@
-require 'raven/interfaces'
+require 'raven/interface'
 
 module Raven
   class MessageInterface < Interface
-    name 'sentry.interfaces.Message'
-    attr_accessor :message
-    attr_accessor :params
+    attr_accessor :message, :params
 
     def initialize(*arguments)
       self.params = []
       super(*arguments)
     end
-  end
 
-  register_interface :message => MessageInterface
+    def unformatted_message
+      message % params
+    end
+
+    def self.sentry_alias
+      :logentry
+    end
+  end
 end

data/lib/raven/interfaces/single_exception.rb

@@ -1,4 +1,4 @@
-require 'raven/interfaces'
+require 'raven/interface'
 
 module Raven
   class SingleExceptionInterface < Interface

data/lib/raven/interfaces/stack_trace.rb

@@ -1,8 +1,7 @@
-require 'raven/interfaces'
+require 'raven/interface'
 
 module Raven
   class StacktraceInterface < Interface
-    name 'stacktrace'
     attr_accessor :frames
 
     def initialize(*arguments)
@@ -10,6 +9,10 @@ module Raven
       super(*arguments)
     end
 
+    def self.sentry_alias
+      :stacktrace
+    end
+
     def to_hash(*args)
       data = super(*args)
       data[:frames] = data[:frames].map(&:to_hash)
@@ -71,6 +74,4 @@ module Raven
       end
     end
   end
-
-  register_interface :stack_trace => StacktraceInterface
 end

data/lib/raven/transports/http.rb

@@ -23,6 +23,8 @@ module Raven
           req.headers['X-Sentry-Auth'] = auth_header
           req.body = data
         end
+      rescue Faraday::ClientError => ex
+        raise Raven::Error, ex.message
       end
 
       private

data/lib/raven/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 module Raven
   # Freezing this constant breaks in 1.9.x
-  VERSION = "2.0.2" # rubocop:disable Style/MutableConstant
+  VERSION = "2.1.0" # rubocop:disable Style/MutableConstant
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sentry-raven
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.1.0
 platform: ruby
 authors:
 - Sentry Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-30 00:00:00.000000000 Z
+date: 2016-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -149,7 +149,7 @@ files:
 - lib/raven/integrations/rake.rb
 - lib/raven/integrations/sidekiq.rb
 - lib/raven/integrations/tasks.rb
-- lib/raven/interfaces.rb
+- lib/raven/interface.rb
 - lib/raven/interfaces/exception.rb
 - lib/raven/interfaces/http.rb
 - lib/raven/interfaces/message.rb