bugsnag 6.12.2 → 6.13.0

data/lib/bugsnag/cleaner.rb

@@ -2,7 +2,6 @@ require 'uri'
 
 module Bugsnag
   class Cleaner
-    ENCODING_OPTIONS = {:invalid => :replace, :undef => :replace}.freeze
     FILTERED = '[FILTERED]'.freeze
     RECURSION = '[RECURSION]'.freeze
     OBJECT = '[OBJECT]'.freeze
@@ -60,9 +59,9 @@ module Bugsnag
     def clean_string(str)
       if defined?(str.encoding) && defined?(Encoding::UTF_8)
         if str.encoding == Encoding::UTF_8
-          str.valid_encoding? ? str : str.encode('utf-16', ENCODING_OPTIONS).encode('utf-8')
+          str.valid_encoding? ? str : str.encode('utf-16', invalid: :replace, undef: :replace).encode('utf-8')
         else
-          str.encode('utf-8', ENCODING_OPTIONS)
+          str.encode('utf-8', invalid: :replace, undef: :replace)
         end
       elsif defined?(Iconv)
         Iconv.conv('UTF-8//IGNORE', 'UTF-8', str) || str

data/lib/bugsnag/configuration.rb

@@ -63,6 +63,10 @@ module Bugsnag
     # @return [Integer] the maximum allowable amount of breadcrumbs per thread
     attr_reader :max_breadcrumbs
 
+    ##
+    # @return [Regexp] matching file paths out of project
+    attr_accessor :vendor_path
+
     API_KEY_REGEX = /[0-9a-f]{32}/i
     THREAD_LOCAL_NAME = "bugsnag_req_data"
 
@@ -81,6 +85,9 @@ module Bugsnag
 
     DEFAULT_MAX_BREADCRUMBS = 25
 
+    # Path to vendored code. Used to mark file paths as out of project.
+    DEFAULT_VENDOR_PATH = %r{^(vendor\/|\.bundle\/)}
+
     alias :track_sessions :auto_capture_sessions
     alias :track_sessions= :auto_capture_sessions=
 
@@ -125,6 +132,11 @@ module Bugsnag
         parse_proxy(proxy_uri)
       end
 
+      # Set up vendor_path regex to mark stacktrace file paths as out of project.
+      # Stacktrace lines that matches regex will be marked as "out of project"
+      # will only appear in the full trace.
+      self.vendor_path = DEFAULT_VENDOR_PATH
+
       # Set up logging
       self.logger = Logger.new(STDOUT)
       self.logger.level = Logger::INFO

data/lib/bugsnag/stacktrace.rb

@@ -7,9 +7,6 @@ module Bugsnag
     # e.g. "org.jruby.Ruby.runScript(Ruby.java:807)"
     JAVA_BACKTRACE_REGEX = /^(.*)\((.*)(?::([0-9]+))?\)$/
 
-    # Path to vendored code. Used to mark file paths as out of project.
-    VENDOR_PATH = /^(vendor\/|\.bundle\/)/
-
     ##
     # Process a backtrace and the configuration into a parsed stacktrace.
     def initialize(backtrace, configuration)
@@ -46,7 +43,7 @@ module Bugsnag
         if defined?(@configuration.project_root) && @configuration.project_root.to_s != ''
           trace_hash[:inProject] = true if file.start_with?(@configuration.project_root.to_s)
           file.sub!(/#{@configuration.project_root}\//, "")
-          trace_hash.delete(:inProject) if file.match(VENDOR_PATH)
+          trace_hash.delete(:inProject) if file.match(@configuration.vendor_path)
         end
 
 

data/spec/configuration_spec.rb

@@ -427,4 +427,15 @@ describe Bugsnag::Configuration do
       expect(second_array).to eq([1, 2])
     end
   end
+
+  describe "#vendor_path" do
+    it "returns the default vendor path" do
+      expect(subject.vendor_path).to eq(Bugsnag::Configuration::DEFAULT_VENDOR_PATH)
+    end
+
+    it "returns the defined vendor path" do
+      subject.vendor_path = /foo/
+      expect(subject.vendor_path).to eq(/foo/)
+    end
+  end
 end

data/spec/fixtures/apps/rails-initializer-config/Gemfile

@@ -1,5 +1,9 @@
 source 'https://rubygems.org'
 
-gem 'railties', '4.2.10', require: %w(action_controller rails)
+ruby_version = Gem::Version.new(RUBY_VERSION.dup)
+
+gem 'railties', ruby_version <= Gem::Version.new('2.6') ? '4.2.10' : '~> 6.0.2', require: %w(action_controller rails)
+gem 'rake', ruby_version <= Gem::Version.new('1.9.3') ? '~> 11.3.0' : '~> 12.3.0'
+gem 'minitest', ruby_version <= Gem::Version.new('2.2') ? '5.11.3' : '~> 5.13.0'
 gem 'nokogiri', '1.6.8'
 gem 'bugsnag', path: '../../../..'

data/spec/fixtures/apps/rails-invalid-initializer-config/Gemfile

@@ -1,5 +1,9 @@
 source 'https://rubygems.org'
 
-gem 'railties', '4.2.10', require: %w(action_controller rails)
+ruby_version = Gem::Version.new(RUBY_VERSION.dup)
+
+gem 'railties', ruby_version <= Gem::Version.new('2.6') ? '4.2.10' : '~> 6.0.2', require: %w(action_controller rails)
+gem 'rake', ruby_version <= Gem::Version.new('1.9.3') ? '~> 11.3.0' : '~> 12.3.0'
+gem 'minitest', ruby_version <= Gem::Version.new('2.2') ? '5.11.3' : '~> 5.13.0'
 gem 'nokogiri', '1.6.8'
 gem 'bugsnag', path: '../../../..'

data/spec/fixtures/apps/rails-no-config/Gemfile

@@ -1,5 +1,9 @@
 source 'https://rubygems.org'
 
-gem 'railties', '4.2.10', require: %w(action_controller rails)
+ruby_version = Gem::Version.new(RUBY_VERSION.dup)
+
+gem 'railties', ruby_version <= Gem::Version.new('2.6') ? '4.2.10' : '~> 6.0.2', require: %w(action_controller rails)
+gem 'rake', ruby_version <= Gem::Version.new('1.9.3') ? '~> 11.3.0' : '~> 12.3.0'
+gem 'minitest', ruby_version <= Gem::Version.new('2.2') ? '5.11.3' : '~> 5.13.0'
 gem 'nokogiri', '1.6.8'
 gem 'bugsnag', path: '../../../..'

data/spec/integrations/logger_spec.rb

@@ -61,7 +61,7 @@ describe 'Configuration.logger' do
       end
     end
 
-    context 'sets an invalid API key using the BUGSNAG_API_KEY env var' do
+    context 'when the API key is invalid in the bugsnag initializer' do
       it 'logs a warning' do
         skip "Incompatible with Ruby <2.0 and JRuby" if incompatible
         output = run_app('rails-invalid-initializer-config')

data/spec/integrations/rake_spec.rb

@@ -58,7 +58,7 @@ describe "Bugsnag Rake integration" do
       ENV['BUGSNAG_TEST_SERVER_PORT'] = server.config[:Port].to_s
       task_fixtures_path = File.join(File.dirname(__FILE__), '../fixtures', 'tasks')
       Dir.chdir(task_fixtures_path) do
-        system("bundle exec rake test:crash > /dev/null 2>&1")
+        system("../../../bin/rake test:crash")
       end
 
       result = request()

data/spec/stacktrace_spec.rb

@@ -87,4 +87,43 @@ describe Bugsnag::Stacktrace do
       })
     }
   end
+
+  context "with configurable vendor_path" do
+    let(:configuration) do
+      configuration = Bugsnag::Configuration.new
+      configuration.project_root = "/foo/bar"
+      configuration
+    end
+
+    let(:backtrace) do
+      [
+        "/foo/bar/app/models/user.rb:1:in `something'",
+        "/foo/bar/other_vendor/lib/dont.rb:1:in `to_s'",
+        "/foo/bar/vendor/lib/ignore_me.rb:1:in `to_s'",
+        "/foo/bar/.bundle/lib/ignore_me.rb:1:in `to_s'",
+      ]
+    end
+
+    def out_project_trace(stacktrace)
+      stacktrace.to_a.map do |trace_line|
+        trace_line[:file] if !trace_line[:inProject]
+      end.compact
+    end
+
+    it "marks vendor/ and .bundle/ as out-project by default" do
+      stacktrace = Bugsnag::Stacktrace.new(backtrace, configuration)
+
+      expect(out_project_trace(stacktrace)).to eq([
+        "vendor/lib/ignore_me.rb",
+        ".bundle/lib/ignore_me.rb",
+      ])
+    end
+
+    it "allows vendor_path to be configured and filters out backtrace file paths" do
+      configuration.vendor_path = /other_vendor\//
+      stacktrace = Bugsnag::Stacktrace.new(backtrace, configuration)
+
+      expect(out_project_trace(stacktrace)).to eq(["other_vendor/lib/dont.rb"])
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bugsnag
 version: !ruby/object:Gem::Version
-  version: 6.12.2
+  version: 6.13.0
 platform: ruby
 authors:
 - James Smith
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-24 00:00:00.000000000 Z
+date: 2020-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -33,22 +33,27 @@ extra_rdoc_files:
 - README.md
 - CHANGELOG.md
 files:
+- ".buildkite/pipeline.yml"
 - ".github/PULL_REQUEST_TEMPLATE.md"
 - ".gitignore"
 - ".rdoc_options"
 - ".rspec"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
-- ".travis.yml"
 - CHANGELOG.md
 - CONTRIBUTING.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- TESTING.md
 - UPGRADING.md
 - VERSION
 - bugsnag.gemspec
+- docker-compose.yml
+- dockerfiles/Dockerfile.jruby-unit-tests
+- dockerfiles/Dockerfile.ruby-maze-runner
+- dockerfiles/Dockerfile.ruby-unit-tests
 - features/.gitignore
 - features/delayed_job.feature
 - features/fixtures/delayed_job/Dockerfile
@@ -127,6 +132,14 @@ files:
 - features/fixtures/delayed_job/app/test/test_helper.rb
 - features/fixtures/delayed_job/app/tmp/.keep
 - features/fixtures/docker-compose.yml
+- features/fixtures/expected_breadcrumbs/active_job.json
+- features/fixtures/expected_breadcrumbs/mongo_failed.json
+- features/fixtures/expected_breadcrumbs/mongo_filtered_request.json
+- features/fixtures/expected_breadcrumbs/mongo_filtered_result.json
+- features/fixtures/expected_breadcrumbs/mongo_success.json
+- features/fixtures/expected_breadcrumbs/request.json
+- features/fixtures/expected_breadcrumbs/sql_with_bindings.json
+- features/fixtures/expected_breadcrumbs/sql_without_bindings.json
 - features/fixtures/plain/.dockerignore
 - features/fixtures/plain/Dockerfile
 - features/fixtures/plain/app/Gemfile
@@ -173,9 +186,9 @@ files:
 - features/fixtures/plain/app/stack_frame_modification/initiators/unhandled_before_notify.rb
 - features/fixtures/plain/app/stack_frame_modification/mark_frames_in_project.rb
 - features/fixtures/plain/app/stack_frame_modification/remove_stack_frame.rb
-- features/fixtures/plain/app/unhandled/Interrupt.rb
 - features/fixtures/plain/app/unhandled/bad_syntax.rb
 - features/fixtures/plain/app/unhandled/custom_error.rb
+- features/fixtures/plain/app/unhandled/interrupt.rb
 - features/fixtures/plain/app/unhandled/load_error.rb
 - features/fixtures/plain/app/unhandled/local_jump_error.rb
 - features/fixtures/plain/app/unhandled/name_error.rb
@@ -450,6 +463,7 @@ files:
 - features/fixtures/rails6/app/app/controllers/handled_controller.rb
 - features/fixtures/rails6/app/app/controllers/ignore_classes_controller.rb
 - features/fixtures/rails6/app/app/controllers/metadata_filters_controller.rb
+- features/fixtures/rails6/app/app/controllers/mongo_controller.rb
 - features/fixtures/rails6/app/app/controllers/project_root_controller.rb
 - features/fixtures/rails6/app/app/controllers/release_stage_controller.rb
 - features/fixtures/rails6/app/app/controllers/send_code_controller.rb
@@ -465,6 +479,7 @@ files:
 - features/fixtures/rails6/app/app/mailers/application_mailer.rb
 - features/fixtures/rails6/app/app/models/application_record.rb
 - features/fixtures/rails6/app/app/models/concerns/.keep
+- features/fixtures/rails6/app/app/models/mongo_model.rb
 - features/fixtures/rails6/app/app/models/user.rb
 - features/fixtures/rails6/app/app/views/layouts/application.html.erb
 - features/fixtures/rails6/app/app/views/layouts/mailer.html.erb
@@ -492,6 +507,7 @@ files:
 - features/fixtures/rails6/app/config/initializers/mime_types.rb
 - features/fixtures/rails6/app/config/initializers/wrap_parameters.rb
 - features/fixtures/rails6/app/config/locales/en.yml
+- features/fixtures/rails6/app/config/mongoid.yml
 - features/fixtures/rails6/app/config/puma.rb
 - features/fixtures/rails6/app/config/routes.rb
 - features/fixtures/rails6/app/config/secrets.yml
@@ -540,6 +556,7 @@ files:
 - features/fixtures/sidekiq/.dockerignore
 - features/fixtures/sidekiq/Dockerfile
 - features/fixtures/sidekiq/app/Gemfile
+- features/fixtures/sidekiq/app/Rakefile.rb
 - features/fixtures/sidekiq/app/app.rb
 - features/fixtures/sidekiq/app/initializers/HandledError.rb
 - features/fixtures/sidekiq/app/initializers/UnhandledError.rb
@@ -556,7 +573,6 @@ files:
 - features/fixtures/sinatra2/Gemfile
 - features/fixtures/sinatra2/app.rb
 - features/plain_features/add_tab.feature
-- features/plain_features/api_key.feature
 - features/plain_features/app_type.feature
 - features/plain_features/app_version.feature
 - features/plain_features/auto_notify.feature

data/.travis.yml

@@ -1,122 +0,0 @@
-sudo: false
-language: ruby
-
-before_install:
-- gem update --system 2.6.14
-- gem --version
-- gem install bundler -v $BUNDLE_VERSION
-- bundle _${BUNDLE_VERSION}_ --version
-
-install:
-- bundle _${BUNDLE_VERSION}_ install --with "$GEMSETS" --binstubs
-
-script:
-- bundle exec ./bin/rake spec
-
-jobs:
-  include:
-  - stage: test
-    env:
-    - BUNDLE_VERSION=1.16.1
-    - GEMSETS=test
-    rvm: jruby-19mode
-  - stage: test
-    rvm: 1.9.3
-    env:
-    - BUNDLE_VERSION=1.12.0
-    - GEMSETS=test
-  - stage: test
-    rvm: 2.0
-    env:
-    - BUNDLE_VERSION=1.12.0
-    - GEMSETS=test
-  - stage: test
-    rvm: 2.1
-    env:
-    - BUNDLE_VERSION=1.12.0
-    - GEMSETS=test
-  - stage: test
-    env:
-    - BUNDLE_VERSION=1.12.0
-    - GEMSETS="test sidekiq"
-    rvm: 2.2
-  - stage: test
-    env:
-    - BUNDLE_VERSION=1.12.0
-    - GEMSETS="test sidekiq"
-    rvm: 2.3
-  - stage: test
-    env:
-    - BUNDLE_VERSION=1.12.0
-    - GEMSETS="test sidekiq"
-    rvm: 2.4
-  - stage: test
-    env:
-    - BUNDLE_VERSION=1.12.0
-    - GEMSETS="test sidekiq"
-    rvm: 2.5
-  - stage: test
-    env:
-    - BUNDLE_VERSION=1.12.0
-    - GEMSETS="test sidekiq coverage"
-    rvm: 2.6
-  - stage: test
-    env:
-    - BUNDLE_VERSION=1.12.0
-    - GEMSETS="test rubocop"
-    rvm: 2.6
-    script: bundle exec ./bin/rubocop lib/
-  # - stage: test
-  #   addons:
-  #     apt:
-  #       packages:
-  #       - docker-ce
-  #   sudo: required
-  #   sevices:
-  #   - docker
-  #   env:
-  #   - BUNDLE_VERSION=1.12.0
-  #   - GEMSETS="test maze"
-  #   rmv: 2.4.1
-  #   script: bundle exec bugsnag-maze-runner -c features/plain_features
-  # - stage: test
-  #   addons:
-  #     apt:
-  #       packages:
-  #       - docker-ce
-  #   sudo: required
-  #   sevices:
-  #   - docker
-  #   env:
-  #   - BUNDLE_VERSION=1.12.0
-  #   - GEMSETS="test maze"
-  #   rmv: 2.4.1
-  #   script: bundle exec bugsnag-maze-runner -c features/sidekiq.feature
-  # - stage: test
-  #   addons:
-  #     apt:
-  #       packages:
-  #       - docker-ce
-  #   sudo: required
-  #   sevices:
-  #   - docker
-  #   env:
-  #   - BUNDLE_VERSION=1.12.0
-  #   - GEMSETS="test maze"
-  #   - MAX_MAZE_CONNECT_ATTEMPTS=20
-  #   rmv: 2.4.1
-  #   script: bundle exec bugsnag-maze-runner -c features/rails_features
-  - stage: deploy
-    env:
-    - BUNDLE_VERSION=1.12.0
-    - GEMSETS="test doc"
-    rvm: 2.4.1
-    script: bundle exec rake rdoc
-    if: tag =~ ^v[1-9]
-    deploy:
-      provider: pages
-      local_dir: rdoc # only include the contents of the generated docs dir
-      skip_cleanup: true
-      github_token: $GITHUB_TOKEN # set in travis-ci dashboard
-      on:
-        tags: true # only deploy when tag is applied to commit

data/features/plain_features/api_key.feature

@@ -1,25 +0,0 @@
-Feature: API Key configuration options
-
-Background:
-  And I configure the bugsnag endpoint
-
-Scenario Outline: The API key configuration option can be set
-  Given I set environment variable "RUBY_VERSION" to "<ruby version>"
-  And I set environment variable "BUGSNAG_API_KEY" to "b35a2a72bd230ac0aa0f52715bbdc6aa"
-  And I have built the service "plain-ruby"
-  And I run the service "plain-ruby" with the command "bundle exec ruby configuration/api_key.rb"
-  And I wait for 1 second
-  Then I should receive a request
-  And the request used the "Ruby Bugsnag Notifier" notifier
-  And the request used payload v4 headers
-  And the request contained the api key "b35a2a72bd230ac0aa0f52715bbdc6aa"
-
-  Examples:
-  | ruby version |
-  | 1.9.3        |
-  | 2.0          |
-  | 2.1          |
-  | 2.2          |
-  | 2.3          |
-  | 2.4          |
-  | 2.5          |