sentry_breakpad 0.1.9 → 0.1.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 96f21c80f9bc540808c52392ac3351b836327867
-  data.tar.gz: 01a4ace182a68378bcaddeb6971aef2ad2c4be62
+  metadata.gz: 57728a993a05e1ce50d874845c1a60eb5b6cb9d0
+  data.tar.gz: e9d3d50f2cb26f67fa8f693e1f5c02f065ce7824
 SHA512:
-  metadata.gz: 446a53d3308df54fc9b529e528e1aa24f56a28e8a78c8a4ef421f6df9993442144571f89dc3ca92c80b9fe5379ddad13b73c33b513948e549c92a82fdec6d5e1
-  data.tar.gz: 683d0cf639f1981fed76da382771faa932803e9c9595a38d34a96d5df79f657a7c003262ed83659aeb945bb513c6e63c9412227bc1c6631735a8a659ae8fad13
+  metadata.gz: 794f61ff285ffa3f2645a815afa1d00357abd6fb656076e143b39a22f8a6443f24d0e0fa1fd664e5b8e6470126fa3e2a4357bed0952977c68e397e13349475f6
+  data.tar.gz: f64c38d31914d28a01cda09cf32b8c1b90ab8302572393b2d5ba5956fa7d64fa0b54386d8fe52a099fffd6febea46a989a409d53af014824afa56f75a8bf667d

data/.gitignore

@@ -1,6 +1,5 @@
 /.bundle/
 /.yardoc
-/Gemfile.lock
 /_yardoc/
 /coverage/
 /doc/

data/.rubocop.yml

@@ -0,0 +1,14 @@
+AllCops:
+  DisplayCopNames: true
+
+Metrics/LineLength:
+  Max: 100
+
+Metrics/MethodLength:
+  Max: 15
+
+Documentation:
+  Enabled: false
+
+Style/AccessModifierIndentation:
+  EnforcedStyle: outdent

data/.travis.yml

@@ -1,4 +1,14 @@
 language: ruby
+cache: bundler
 rvm:
-  - 2.2.2
-before_install: gem install bundler -v 1.10.6
+  - 1.9
+  - 1.9.3
+  - 2.0
+  - 2.1
+  - 2.2
+  - 2.3.3
+  - 2.4.0
+before_install: gem update --remote bundler
+script:
+  - bundle exec rspec
+  - bundle exec rubocop -c .rubocop.yml

data/Gemfile.lock

@@ -0,0 +1,52 @@
+PATH
+  remote: .
+  specs:
+    sentry_breakpad (0.1.10)
+      sentry-raven (~> 2.2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.3.0)
+    diff-lcs (1.2.5)
+    faraday (0.10.0)
+      multipart-post (>= 1.2, < 3)
+    multipart-post (2.0.0)
+    parser (2.3.3.1)
+      ast (~> 2.2)
+    powerpack (0.1.1)
+    rainbow (2.1.0)
+    rspec (3.4.0)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+    rspec-core (3.4.2)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
+    rubocop (0.38.0)
+      parser (>= 2.3.0.6, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.8.1)
+    sentry-raven (2.2.0)
+      faraday (>= 0.7.6, < 1.0)
+    unicode-display_width (1.1.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rspec
+  rubocop
+  sentry_breakpad!
+
+BUNDLED WITH
+   1.13.6

data/README.md

@@ -1,3 +1,5 @@
+[![Build Status](https://api.travis-ci.org/wk8/sentry_breakpad.svg?branch=master)](https://travis-ci.org/wk8/sentry_breakpad)
+
 # SentryBreakpad
 
 So you've integrated [Google
@@ -139,7 +141,6 @@ SentryBreakpad.send_from_file('/path/to/report', {
 ```
 
 The exhaustive list of all the extra information that can be passed can be found
-at https://github.com/getsentry/raven-ruby/blob/0.15.3/lib/raven/event.rb#L31-L49.
 
 Please note that all of the above assumes that `Raven` has been properly configured
 (we use `Raven.client` to send the generated events)
@@ -154,7 +155,6 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/wk8/sentry_breakpad.
 
-
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -1,6 +1,6 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/bin/console

@@ -1,14 +1,14 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "sentry_breakpad"
+require 'bundler/setup'
+require 'sentry_breakpad'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
 
 # (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
+# require 'pry'
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start

data/lib/sentry_breakpad.rb

@@ -1,22 +1,23 @@
 require 'sentry_breakpad/version'
 require 'sentry_breakpad/breakpad_parser'
+require 'sentry_breakpad/hash_helper'
 
 require 'raven'
 
 module SentryBreakpad
   class << self
-    def send_from_file(file_path, extra_info = {}, include_whole_report = true)
-      send_event(BreakpadParser.from_file(file_path), extra_info, include_whole_report)
+    def send_from_file(file_path, extra_info = {})
+      send_event(BreakpadParser.from_file(file_path), extra_info)
     end
 
-    def send_from_string(string, extra_info = {}, include_whole_report = true)
-      send_event(BreakpadParser.new(string), extra_info, include_whole_report)
+    def send_from_string(string, extra_info = {})
+      send_event(BreakpadParser.new(string), extra_info)
     end
 
   private
 
-    def send_event(parser, extra_info, include_whole_report)
-      Raven.client.send_event(parser.raven_event(extra_info, include_whole_report))
+    def send_event(parser, extra_info)
+      Raven.client.send_event(parser.raven_event(extra_info))
     end
   end
 end

data/lib/sentry_breakpad/breakpad_parser.rb

@@ -1,63 +1,59 @@
 require 'raven'
 
 module SentryBreakpad
-  # parses a breakpad report
-  class BreakpadParser
+  # parses a breakpad report and turns it into a Raven event
+  class BreakpadParser # rubocop:disable Metrics/ClassLength
     def self.from_file(file_path)
-      new(File.open(file_path).read)
+      new(File.read(file_path))
     end
 
     def initialize(breakpad_report_content)
       @breakpad_report_content = breakpad_report_content
-      @parsed = false
 
       @message = nil
       @tags = {}
       @crashed_thread_stacktrace = []
+      # TODO: this is not leveraged yet, because the ruby-raven gem doesn't
+      # support this yet...
+      # come back to integrating other threads' stacktraces when
+      # https://github.com/getsentry/raven-ruby/issues/551
+      # is resolved
+      @other_threads_stacktraces = {}
       @culprit = nil
       @modules = {}
       @extra = {}
-    end
 
-    def raven_event(extra_info = {}, include_whole_report = true)
-      hash = deep_merge(raven_event_hash(include_whole_report), extra_info)
-      Raven::Event.new(hash)
+      parse!
     end
 
-    def raven_event_hash(include_whole_report = true)
-      parse
-
-      extra = if include_whole_report
-        @extra.merge({'raw_breakpad_report' => @breakpad_report_content})
-      else
-        @extra
+    def raven_event(extra_info = {})
+      hash = HashHelper.deep_merge!(base_event_hash, HashHelper.deep_symbolize_keys!(extra_info))
+      Raven::Event.new(hash).tap do |event|
+        unless @crashed_thread_stacktrace.empty?
+          event[:stacktrace] = { frames: @crashed_thread_stacktrace }
+        end
       end
-
-      {
-        'message'    => @message,
-        'tags'       => @tags,
-        'culprit'    => @culprit,
-        'modules'    => @modules,
-        'extra'      => extra,
-        'level'      => 'fatal',
-        'logger'     => 'breakpad',
-        'interfaces' => {
-          'stacktrace' => {
-            'frames' => @crashed_thread_stacktrace
-          }
-        }
-      }
     end
 
   private
 
-    def parse
-      return if @parsed
+    def base_event_hash
+      {
+        message: @message,
+        tags:    @tags,
+        culprit: @culprit,
+        modules: @modules,
+        extra:   @extra,
+        level:   'fatal',
+        logger:  'breakpad'
+      }
+    end
 
+    def parse!
       parse_lines(@breakpad_report_content.split("\n").reverse!)
     end
 
-    def parse_lines(lines)
+    def parse_lines(lines) # rubocop:disable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/MethodLength, Metrics/LineLength
       until lines.empty?
         case lines.last
         when /^Operating system:/
@@ -68,8 +64,8 @@ module SentryBreakpad
           parse_crash_reason(lines.pop)
         when /^Crash address:/
           parse_crash_address(lines.pop)
-        when /^Thread ([0-9]+) \(crashed\)/
-          parse_crashed_thread_stacktrace(lines, $1.to_i)
+        when /^Thread ([0-9]+)(\s+\(crashed\))?/
+          parse_thread_stacktrace(lines, Regexp.last_match[1].to_i, !Regexp.last_match[2].nil?)
         when /^Loaded modules:/
           parse_loaded_modules(lines)
         else
@@ -82,7 +78,15 @@ module SentryBreakpad
     # Operating system: Windows NT
     #                   6.1.7601 Service Pack 1
     def parse_operating_system(lines)
-      parse_indented_section(lines, 'Operating system:', 'os')
+      parse_indented_section(lines, 'Operating system:', :os)
+
+      if @tags[:os]
+        @extra[:server] ||= {}
+        @extra[:server][:os] = {
+          name: @tags[:os],
+          version: @tags[:os_full]
+        }
+      end
     end
 
     # Parses something of the form
@@ -90,7 +94,7 @@ module SentryBreakpad
     #      GenuineIntel family 6 model 70 stepping 1
     #      4 CPUs
     def parse_cpu(lines)
-      parse_indented_section(lines, 'CPU:', 'cpu')
+      parse_indented_section(lines, 'CPU:', :cpu)
     end
 
     def parse_indented_section(lines, prefix, tag_name)
@@ -102,7 +106,7 @@ module SentryBreakpad
       end
 
       @tags[tag_name] = short
-      @tags["#{tag_name}_full"] = long
+      @tags["#{tag_name}_full".to_sym] = long
     end
 
     # Parses a single line like
@@ -110,12 +114,12 @@ module SentryBreakpad
     def parse_crash_reason(line)
       reason = remove_prefix(line, 'Crash reason:')
 
-      if @message.nil?
-        @message = reason
-      else
-        # we parse the crashed thread first
-        @message = "#{reason} at #{@message}"
-      end
+      @message = if @message.nil?
+                   reason
+                 else
+                   # we parse the crashed thread first
+                   "#{reason} at #{@message}"
+                 end
     end
 
     # Parses a single line like
@@ -123,7 +127,7 @@ module SentryBreakpad
     def parse_crash_address(line)
       address = remove_prefix(line, 'Crash address:')
 
-      @extra['crash_address'] = address
+      @extra[:crash_address] = address
     end
 
     def remove_prefix(line, prefix)
@@ -131,8 +135,9 @@ module SentryBreakpad
       line.strip
     end
 
-    BACKTRACE_LINE_REGEX = /^\s*([0-9]+)\s+(.*)\s+(?:\[(([^ ]+)\s+:\s+([0-9]+))\s+\+\s+0x[0-9a-f]+\]|\+\s+0x[0-9a-f]+)\s*$/
+    BACKTRACE_LINE_REGEX = /^\s*([0-9]+)\s+(.*)\s+(?:\[(([^ ]+)\s+:\s+([0-9]+))\s+\+\s+0x[0-9a-f]+\]|\+\s+0x[0-9a-f]+)\s*$/ # rubocop:disable Metrics/LineLength
 
+    # rubocop:disable Metrics/LineLength
     # Parses something of the form
     # Thread 0 (crashed)
     #  0  ETClient.exe!QString::~QString() [qstring.h : 992 + 0xa]
@@ -182,48 +187,58 @@ module SentryBreakpad
     # 14  ETClient.exe!WinMain + 0x21358
     #     eip = 0x015bb068   esp = 0x0018d690   ebp = 0x0018d7f8
     #     Found by: call frame info
-    def parse_crashed_thread_stacktrace(lines, thread_id)
+    # rubocop:enable Metrics/LineLength
+    def parse_thread_stacktrace(lines, thread_id, is_crashed_thread)
       # remove the 1st line
       lines.pop
 
       stacktrace = []
       process_matching_lines(lines, BACKTRACE_LINE_REGEX) do |match|
-        frame_nb = match[1]
-        function = match[2]
-        filename = match[4] || 'unknown'
-        lineno   = match[5]
-
-        frame = {
-          'filename' => filename,
-          'function' => function
-        }
-        frame['lineno'] = lineno.to_i if lineno
+        stacktrace << parse_crashed_thread_stacktrace_line(match, is_crashed_thread)
+      end
 
-        stacktrace << frame
+      # sentry wants their stacktrace with the oldest frame first
+      stacktrace = stacktrace.reverse
 
-        if frame_nb.to_i == 0
-          @culprit = function
+      if is_crashed_thread
+        @crashed_thread_stacktrace = stacktrace
+        @extra[:crashed_thread_id] = thread_id
+      else
+        @other_threads_stacktraces[thread_id] = stacktrace
+      end
+    end
 
-          message_tail = function
-          message_tail += " (#{match[3]})" if match[3]
+    def parse_crashed_thread_stacktrace_line(match, is_crashed_thread)
+      frame_nb = match[1]
+      function = match[2]
+      filename = match[4] || 'unknown'
+      lineno   = match[5]
 
-          if @message.nil?
-            @message = message_tail
-          else
-            # already parsed the crash reason
-            @message += " at #{message_tail}"
-          end
-        end
-      end
+      parse_culprit_and_message(function, match[3]) if is_crashed_thread && frame_nb.to_i == 0
 
-      # sentry wants their stacktrace with the oldest frame first
-      @crashed_thread_stacktrace = stacktrace.reverse
+      {
+        filename: filename,
+        function: function
+      }.tap { |frame| frame[:lineno] = lineno.to_i if lineno }
+    end
+
+    def parse_culprit_and_message(function, file_name_and_lineno)
+      @culprit = function
 
-      @extra['crashed_thread_id'] = thread_id
+      message_tail = function
+      message_tail += " (#{file_name_and_lineno})" if file_name_and_lineno
+
+      if @message.nil?
+        @message = message_tail
+      else
+        # already parsed the crash reason
+        @message += " at #{message_tail}"
+      end
     end
 
     MODULE_LINE_REGEX = /0x[0-9a-f]+\s+-\s+0x[0-9a-f]+\s+([^ ]+)\s+([^ ]+)/
 
+    # rubocop:disable Metrics/LineLength
     # Parses something of the form
     # Loaded modules:
     # 0x00d70000 - 0x01b39fff  ETClient.exe  ???  (main)
@@ -278,6 +293,7 @@ module SentryBreakpad
     # 0x76f90000 - 0x76feffff  imm32.dll  6.1.7601.17514
     # 0x76ff0000 - 0x77016fff  cfgmgr32.dll  6.1.7601.17621
     # 0x77420000 - 0x7759ffff  ntdll.dll  6.1.7601.19110  (WARNING: No symbols, wntdll.pdb, 992AA396746C4D548F7F497DD63B4EEC2)
+    # rubocop:enable Metrics/LineLength
     def parse_loaded_modules(lines)
       # remove the 1st line
       lines.pop
@@ -290,7 +306,7 @@ module SentryBreakpad
       end
     end
 
-    def process_matching_lines(lines, regex, &blk)
+    def process_matching_lines(lines, regex, &_blk)
       loop do
         line = lines.pop
         line.strip! if line
@@ -301,19 +317,5 @@ module SentryBreakpad
         yield(match) if match
       end
     end
-
-    # merges hash2 into hash1, recursively
-    # wish ActiveSupport was around...
-    def deep_merge(hash1, hash2)
-      hash2.each do |key, value|
-        if hash1.key?(value) && hash1[key].is_a?(Hash) && value.is_a?(Hash)
-          hash1[key] = deep_merge(hash1[key], value)
-        else
-          hash1[key] = value
-        end
-      end 
-
-      hash1
-    end
   end
 end

data/lib/sentry_breakpad/hash_helper.rb

@@ -0,0 +1,30 @@
+# Seemed somewhat silly to pull ActiveSupport as a dependency for just a couple
+# of methods...
+
+module SentryBreakpad
+  class HashHelper
+    class << self
+      # merges hash2 into hash1, recursively
+      def deep_merge!(hash1, hash2)
+        hash2.each do |key, value|
+          hash1[key] = if hash1.key?(key) && hash1[key].is_a?(Hash) && value.is_a?(Hash)
+                         deep_merge!(hash1[key], value)
+                       else
+                         value
+                       end
+        end
+
+        hash1
+      end
+
+      # recursively symbolizes a hash's keys
+      def deep_symbolize_keys!(hash)
+        hash.each_with_object({}) do |(key, value), new_hash|
+          new_key = key.respond_to?(:to_sym) ? key.to_sym : key
+          new_value = value.is_a?(Hash) ? deep_symbolize_keys!(value) : value
+          new_hash[new_key] = new_value
+        end
+      end
+    end
+  end
+end

data/lib/sentry_breakpad/version.rb

@@ -1,3 +1,3 @@
 module SentryBreakpad
-  VERSION = "0.1.9"
+  VERSION = '0.1.10'.freeze
 end

data/sentry_breakpad.gemspec

@@ -4,21 +4,22 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'sentry_breakpad/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "sentry_breakpad"
-  spec.version       = SentryBreakpad::VERSION
-  spec.authors       = ["Jean Rouge"]
-  spec.email         = ["jer329@cornell.edu"]
+  spec.name = 'sentry_breakpad'
+  spec.version = SentryBreakpad::VERSION
+  spec.authors = ['Jean Rouge']
+  spec.email = ['jer329@cornell.edu']
 
-  spec.summary       = %q{Converts Google breakpad's reports into Sentry/Raven events}
-  spec.homepage      = "https://github.com/wk8/sentry_breakpad"
-  spec.license       = "MIT"
+  spec.summary = "Converts Google breakpad's reports into Sentry/Raven events"
+  spec.homepage = 'https://github.com/wk8/sentry_breakpad'
+  spec.license = 'MIT'
 
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
 
-  spec.add_dependency "sentry-raven", "~> 2.2.0"
+  spec.add_dependency 'sentry-raven', '~> 2.2.0'
 
-  spec.add_development_dependency "rspec"
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rubocop'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sentry_breakpad
 version: !ruby/object:Gem::Version
-  version: 0.1.9
+  version: 0.1.10
 platform: ruby
 authors:
 - Jean Rouge
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-12-12 00:00:00.000000000 Z
+date: 2016-12-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sentry-raven
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email:
 - jer329@cornell.edu
@@ -47,8 +61,10 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -56,6 +72,7 @@ files:
 - bin/setup
 - lib/sentry_breakpad.rb
 - lib/sentry_breakpad/breakpad_parser.rb
+- lib/sentry_breakpad/hash_helper.rb
 - lib/sentry_breakpad/version.rb
 - sentry_breakpad.gemspec
 homepage: https://github.com/wk8/sentry_breakpad