+ Raises an exception within the framework, but with additional data
+ attached to the report. By registering a callback before the error
+ occurs useful data can be attached as a tab in the Bugsnag dashboard.
+
+ Sends Bugsnag a report on demand using bugsnag.notify.
+ Allows details of handled errors or information to be sent to the
+ Bugsnag dashboard without crashing your code.
+
+ Raises an exception within the framework, but with additional data
+ attached to the report. By registering a callback before the error
+ occurs useful data can be attached as a tab in the Bugsnag dashboard.
+
+ Sends Bugsnag a report on demand using bugsnag.notify
+ and attaches additional data within a block, similar to
+ the "Crash and use callbacks" example above. In this case we're
+ adding information about the function being called to go into the
+ function tab, and additional diagnostics
+ as a diagnostics tab.
+
diff --git a/example/rails-60/app/workers/resque_workers.rb b/example/rails-60/app/workers/resque_workers.rb
new file mode 100644
index 000000000..1b0feee35
--- /dev/null
+++ b/example/rails-60/app/workers/resque_workers.rb
@@ -0,0 +1,47 @@
+module ResqueWorkers
+ class Crash
+ @queue = :crash
+
+ def self.perform
+ raise 'Crashed - Check your Bugsnag dashboard'
+ end
+ end
+
+ # Unhandled with callback Exception example
+ class Callback
+ @queue = :callback
+
+ def self.perform
+ Bugsnag.before_notify_callbacks << proc { |report|
+ report.add_tab(:diagnostics, {
+ message: 'Resque demo says: Everything is great',
+ code: 200
+ })
+ }
+
+ raise 'Crashed - Check the Bugsnag dashboard for diagnostic data'
+ end
+ end
+
+ # Handled example with additional data
+ class Metadata
+ @queue = :metadata
+
+ def self.perform
+ error = Exception.new "Didn't crash, but sent a notification anyway"
+
+ Bugsnag.notify(error) do |report|
+ report.add_tab(:queue, {
+ :name => "metadata",
+ :fatal => false
+ })
+
+ report.add_tab(:diagnostics, {
+ :message => 'Resque demo says: Everything is great'
+ })
+ end
+
+ puts "The Resque worker hasn't crashed, but it has sent a notification, with additional data to the dashboard"
+ end
+ end
+end
diff --git a/example/rails-60/app/workers/sidekiq_workers.rb b/example/rails-60/app/workers/sidekiq_workers.rb
new file mode 100644
index 000000000..59bfddef1
--- /dev/null
+++ b/example/rails-60/app/workers/sidekiq_workers.rb
@@ -0,0 +1,47 @@
+module SidekiqWorkers
+ class CallbackWorker
+ include Sidekiq::Worker
+
+ sidekiq_options :retry => false
+
+ def perform
+ Bugsnag.before_notify_callbacks << proc { |report|
+ report.add_tab(:diagnostics, {
+ message: 'Sidekiq demo says: Everything is great',
+ code: 200
+ })
+ }
+
+ raise 'Sidekiq crashed, but the callback added metadata - Check your Bugsnag dashboard'
+ end
+ end
+
+ class CrashWorker
+ include Sidekiq::Worker
+ sidekiq_options :retry => false
+
+ def perform
+ raise 'Sidekiq crashed - Check your Bugsnag dashboard'
+ end
+ end
+
+ class MetadataWorker
+ include Sidekiq::Worker
+ sidekiq_options :retry => false
+
+ def perform
+ error = Exception.new('Sidekiq notified with metadata - Check your Bugsnag dashboard')
+
+ Bugsnag.notify(error) do |report|
+ report.add_tab(:function, {
+ name: 'Metadata',
+ fatal: false
+ })
+
+ report.add_tab(:diagnostics, {
+ message: 'Sidekiq demo says: Everything is great',
+ })
+ end
+ end
+ end
+end
diff --git a/example/rails-60/babel.config.js b/example/rails-60/babel.config.js
new file mode 100644
index 000000000..12f98da5a
--- /dev/null
+++ b/example/rails-60/babel.config.js
@@ -0,0 +1,72 @@
+module.exports = function(api) {
+ var validEnv = ['development', 'test', 'production']
+ var currentEnv = api.env()
+ var isDevelopmentEnv = api.env('development')
+ var isProductionEnv = api.env('production')
+ var isTestEnv = api.env('test')
+
+ if (!validEnv.includes(currentEnv)) {
+ throw new Error(
+ 'Please specify a valid `NODE_ENV` or ' +
+ '`BABEL_ENV` environment variables. Valid values are "development", ' +
+ '"test", and "production". Instead, received: ' +
+ JSON.stringify(currentEnv) +
+ '.'
+ )
+ }
+
+ return {
+ presets: [
+ isTestEnv && [
+ '@babel/preset-env',
+ {
+ targets: {
+ node: 'current'
+ }
+ }
+ ],
+ (isProductionEnv || isDevelopmentEnv) && [
+ '@babel/preset-env',
+ {
+ forceAllTransforms: true,
+ useBuiltIns: 'entry',
+ corejs: 3,
+ modules: false,
+ exclude: ['transform-typeof-symbol']
+ }
+ ]
+ ].filter(Boolean),
+ plugins: [
+ 'babel-plugin-macros',
+ '@babel/plugin-syntax-dynamic-import',
+ isTestEnv && 'babel-plugin-dynamic-import-node',
+ '@babel/plugin-transform-destructuring',
+ [
+ '@babel/plugin-proposal-class-properties',
+ {
+ loose: true
+ }
+ ],
+ [
+ '@babel/plugin-proposal-object-rest-spread',
+ {
+ useBuiltIns: true
+ }
+ ],
+ [
+ '@babel/plugin-transform-runtime',
+ {
+ helpers: false,
+ regenerator: true,
+ corejs: false
+ }
+ ],
+ [
+ '@babel/plugin-transform-regenerator',
+ {
+ async: false
+ }
+ ]
+ ].filter(Boolean)
+ }
+}
diff --git a/example/rails-60/config.ru b/example/rails-60/config.ru
new file mode 100644
index 000000000..f7ba0b527
--- /dev/null
+++ b/example/rails-60/config.ru
@@ -0,0 +1,5 @@
+# This file is used by Rack-based servers to start the application.
+
+require_relative 'config/environment'
+
+run Rails.application
diff --git a/example/rails-60/config/application.rb b/example/rails-60/config/application.rb
new file mode 100644
index 000000000..7606973a3
--- /dev/null
+++ b/example/rails-60/config/application.rb
@@ -0,0 +1,19 @@
+require_relative 'boot'
+
+require 'rails/all'
+
+# Require the gems listed in Gemfile, including any gems
+# you've limited to :test, :development, or :production.
+Bundler.require(*Rails.groups)
+
+module Rails60
+ class Application < Rails::Application
+ # Initialize configuration defaults for originally generated Rails version.
+ config.load_defaults 6.0
+
+ # Settings in config/environments/* take precedence over those specified here.
+ # Application configuration can go into files in config/initializers
+ # -- all .rb files in that directory are automatically loaded after loading
+ # the framework and any gems in your application.
+ end
+end
diff --git a/example/rails-60/config/boot.rb b/example/rails-60/config/boot.rb
new file mode 100644
index 000000000..b9e460cef
--- /dev/null
+++ b/example/rails-60/config/boot.rb
@@ -0,0 +1,4 @@
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__)
+
+require 'bundler/setup' # Set up gems listed in the Gemfile.
+require 'bootsnap/setup' # Speed up boot time by caching expensive operations.
diff --git a/example/rails-60/config/cable.yml b/example/rails-60/config/cable.yml
new file mode 100644
index 000000000..e168aa54b
--- /dev/null
+++ b/example/rails-60/config/cable.yml
@@ -0,0 +1,10 @@
+development:
+ adapter: async
+
+test:
+ adapter: test
+
+production:
+ adapter: redis
+ url: <%= ENV.fetch("REDIS_URL") { "redis://localhost:6379/1" } %>
+ channel_prefix: rails_60_production
diff --git a/example/rails-60/config/credentials.yml.enc b/example/rails-60/config/credentials.yml.enc
new file mode 100644
index 000000000..e015aa824
--- /dev/null
+++ b/example/rails-60/config/credentials.yml.enc
@@ -0,0 +1 @@
+KQhHHa39d1cmOiryTxmJvb3odw1lJYakJGSiQ8FJQGokXbkGPDUpG8UPuuvdKdwvh2O03jgdRlZ5ZeGtDgUeEVgSeWdGsvAXH9mwKfLxqm5lQuq5DfEnOOEpzAoReLpu4Hp7kmdJEwz/APbiEZ74NEFz94nDyWFkZwKsH1NSATVicP3gvGO0fgY0/ADOGcezOLcMrHCckCIap1oe4Fr68R0YbQxUhaNfZzsQN2RPHCw4fvQARYZcEPiTpoPRMwZsxkFdWQCpUUuQASdMFuu3+Cq//+Q57V+k3F353s52pQ1qCX/Oq0pBe8XXTzzQVK+x35xD7puFsz3N7wa2RtkmdUR0SsS/b92MRHMB94KjnQWLn7FS8/rYtDaiv6WnrXSGzwhOOtW8M3vOi35F1yoiUuM6bfIW68sCR3LR--hk5vbvf0FXhi6gl0--1WNlajBXqT6SQsGjKFHIlQ==
\ No newline at end of file
diff --git a/example/rails-60/config/database.yml b/example/rails-60/config/database.yml
new file mode 100644
index 000000000..832c7883a
--- /dev/null
+++ b/example/rails-60/config/database.yml
@@ -0,0 +1,32 @@
+# SQLite. Versions 3.8.0 and up are supported.
+# gem install sqlite3
+#
+# Ensure the SQLite 3 gem is defined in your Gemfile
+# gem 'sqlite3'
+#
+default: &default
+ adapter: sqlite3
+ pool: <%= ENV.fetch("RAILS_MAX_THREADS") { 5 } %>
+ timeout: 5000
+
+que:
+ adapter: postgresql
+ pool: <%= ENV.fetch("RAILS_MAX_THREADS") { 5 } %>
+ host: localhost
+ timeout: 5000
+ database: quedb
+
+development:
+ <<: *default
+ database: db/development.sqlite3
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+ <<: *default
+ database: db/test.sqlite3
+
+production:
+ <<: *default
+ database: db/production.sqlite3
diff --git a/example/rails-60/config/environment.rb b/example/rails-60/config/environment.rb
new file mode 100644
index 000000000..426333bb4
--- /dev/null
+++ b/example/rails-60/config/environment.rb
@@ -0,0 +1,5 @@
+# Load the Rails application.
+require_relative 'application'
+
+# Initialize the Rails application.
+Rails.application.initialize!
diff --git a/example/rails-60/config/environments/development.rb b/example/rails-60/config/environments/development.rb
new file mode 100644
index 000000000..66df51f6f
--- /dev/null
+++ b/example/rails-60/config/environments/development.rb
@@ -0,0 +1,62 @@
+Rails.application.configure do
+ # Settings specified here will take precedence over those in config/application.rb.
+
+ # In the development environment your application's code is reloaded on
+ # every request. This slows down response time but is perfect for development
+ # since you don't have to restart the web server when you make code changes.
+ config.cache_classes = false
+
+ # Do not eager load code on boot.
+ config.eager_load = false
+
+ # Show full error reports.
+ config.consider_all_requests_local = true
+
+ # Enable/disable caching. By default caching is disabled.
+ # Run rails dev:cache to toggle caching.
+ if Rails.root.join('tmp', 'caching-dev.txt').exist?
+ config.action_controller.perform_caching = true
+ config.action_controller.enable_fragment_cache_logging = true
+
+ config.cache_store = :memory_store
+ config.public_file_server.headers = {
+ 'Cache-Control' => "public, max-age=#{2.days.to_i}"
+ }
+ else
+ config.action_controller.perform_caching = false
+
+ config.cache_store = :null_store
+ end
+
+ # Store uploaded files on the local file system (see config/storage.yml for options).
+ config.active_storage.service = :local
+
+ # Don't care if the mailer can't send.
+ config.action_mailer.raise_delivery_errors = false
+
+ config.action_mailer.perform_caching = false
+
+ # Print deprecation notices to the Rails logger.
+ config.active_support.deprecation = :log
+
+ # Raise an error on page load if there are pending migrations.
+ config.active_record.migration_error = :page_load
+
+ # Highlight code that triggered database queries in logs.
+ config.active_record.verbose_query_logs = true
+
+ # Debug mode disables concatenation and preprocessing of assets.
+ # This option may cause significant delays in view rendering with a large
+ # number of complex assets.
+ config.assets.debug = true
+
+ # Suppress logger output for asset requests.
+ config.assets.quiet = true
+
+ # Raises error for missing translations.
+ # config.action_view.raise_on_missing_translations = true
+
+ # Use an evented file watcher to asynchronously detect changes in source code,
+ # routes, locales, etc. This feature depends on the listen gem.
+ config.file_watcher = ActiveSupport::EventedFileUpdateChecker
+end
diff --git a/example/rails-60/config/environments/production.rb b/example/rails-60/config/environments/production.rb
new file mode 100644
index 000000000..244c22e00
--- /dev/null
+++ b/example/rails-60/config/environments/production.rb
@@ -0,0 +1,112 @@
+Rails.application.configure do
+ # Settings specified here will take precedence over those in config/application.rb.
+
+ # Code is not reloaded between requests.
+ config.cache_classes = true
+
+ # Eager load code on boot. This eager loads most of Rails and
+ # your application in memory, allowing both threaded web servers
+ # and those relying on copy on write to perform better.
+ # Rake tasks automatically ignore this option for performance.
+ config.eager_load = true
+
+ # Full error reports are disabled and caching is turned on.
+ config.consider_all_requests_local = false
+ config.action_controller.perform_caching = true
+
+ # Ensures that a master key has been made available in either ENV["RAILS_MASTER_KEY"]
+ # or in config/master.key. This key is used to decrypt credentials (and other encrypted files).
+ # config.require_master_key = true
+
+ # Disable serving static files from the `/public` folder by default since
+ # Apache or NGINX already handles this.
+ config.public_file_server.enabled = ENV['RAILS_SERVE_STATIC_FILES'].present?
+
+ # Compress CSS using a preprocessor.
+ # config.assets.css_compressor = :sass
+
+ # Do not fallback to assets pipeline if a precompiled asset is missed.
+ config.assets.compile = false
+
+ # Enable serving of images, stylesheets, and JavaScripts from an asset server.
+ # config.action_controller.asset_host = 'http://assets.example.com'
+
+ # Specifies the header that your server uses for sending files.
+ # config.action_dispatch.x_sendfile_header = 'X-Sendfile' # for Apache
+ # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect' # for NGINX
+
+ # Store uploaded files on the local file system (see config/storage.yml for options).
+ config.active_storage.service = :local
+
+ # Mount Action Cable outside main process or domain.
+ # config.action_cable.mount_path = nil
+ # config.action_cable.url = 'wss://example.com/cable'
+ # config.action_cable.allowed_request_origins = [ 'http://example.com', /http:\/\/example.*/ ]
+
+ # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies.
+ # config.force_ssl = true
+
+ # Use the lowest log level to ensure availability of diagnostic information
+ # when problems arise.
+ config.log_level = :debug
+
+ # Prepend all log lines with the following tags.
+ config.log_tags = [ :request_id ]
+
+ # Use a different cache store in production.
+ # config.cache_store = :mem_cache_store
+
+ # Use a real queuing backend for Active Job (and separate queues per environment).
+ # config.active_job.queue_adapter = :resque
+ # config.active_job.queue_name_prefix = "rails_60_production"
+
+ config.action_mailer.perform_caching = false
+
+ # Ignore bad email addresses and do not raise email delivery errors.
+ # Set this to true and configure the email server for immediate delivery to raise delivery errors.
+ # config.action_mailer.raise_delivery_errors = false
+
+ # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
+ # the I18n.default_locale when a translation cannot be found).
+ config.i18n.fallbacks = true
+
+ # Send deprecation notices to registered listeners.
+ config.active_support.deprecation = :notify
+
+ # Use default logging formatter so that PID and timestamp are not suppressed.
+ config.log_formatter = ::Logger::Formatter.new
+
+ # Use a different logger for distributed setups.
+ # require 'syslog/logger'
+ # config.logger = ActiveSupport::TaggedLogging.new(Syslog::Logger.new 'app-name')
+
+ if ENV["RAILS_LOG_TO_STDOUT"].present?
+ logger = ActiveSupport::Logger.new(STDOUT)
+ logger.formatter = config.log_formatter
+ config.logger = ActiveSupport::TaggedLogging.new(logger)
+ end
+
+ # Do not dump schema after migrations.
+ config.active_record.dump_schema_after_migration = false
+
+ # Inserts middleware to perform automatic connection switching.
+ # The `database_selector` hash is used to pass options to the DatabaseSelector
+ # middleware. The `delay` is used to determine how long to wait after a write
+ # to send a subsequent read to the primary.
+ #
+ # The `database_resolver` class is used by the middleware to determine which
+ # database is appropriate to use based on the time delay.
+ #
+ # The `database_resolver_context` class is used by the middleware to set
+ # timestamps for the last write to the primary. The resolver uses the context
+ # class timestamps to determine how long to wait before reading from the
+ # replica.
+ #
+ # By default Rails will store a last write timestamp in the session. The
+ # DatabaseSelector middleware is designed as such you can define your own
+ # strategy for connection switching and pass that into the middleware through
+ # these configuration options.
+ # config.active_record.database_selector = { delay: 2.seconds }
+ # config.active_record.database_resolver = ActiveRecord::Middleware::DatabaseSelector::Resolver
+ # config.active_record.database_resolver_context = ActiveRecord::Middleware::DatabaseSelector::Resolver::Session
+end
diff --git a/example/rails-60/config/environments/que.rb b/example/rails-60/config/environments/que.rb
new file mode 100644
index 000000000..66df51f6f
--- /dev/null
+++ b/example/rails-60/config/environments/que.rb
@@ -0,0 +1,62 @@
+Rails.application.configure do
+ # Settings specified here will take precedence over those in config/application.rb.
+
+ # In the development environment your application's code is reloaded on
+ # every request. This slows down response time but is perfect for development
+ # since you don't have to restart the web server when you make code changes.
+ config.cache_classes = false
+
+ # Do not eager load code on boot.
+ config.eager_load = false
+
+ # Show full error reports.
+ config.consider_all_requests_local = true
+
+ # Enable/disable caching. By default caching is disabled.
+ # Run rails dev:cache to toggle caching.
+ if Rails.root.join('tmp', 'caching-dev.txt').exist?
+ config.action_controller.perform_caching = true
+ config.action_controller.enable_fragment_cache_logging = true
+
+ config.cache_store = :memory_store
+ config.public_file_server.headers = {
+ 'Cache-Control' => "public, max-age=#{2.days.to_i}"
+ }
+ else
+ config.action_controller.perform_caching = false
+
+ config.cache_store = :null_store
+ end
+
+ # Store uploaded files on the local file system (see config/storage.yml for options).
+ config.active_storage.service = :local
+
+ # Don't care if the mailer can't send.
+ config.action_mailer.raise_delivery_errors = false
+
+ config.action_mailer.perform_caching = false
+
+ # Print deprecation notices to the Rails logger.
+ config.active_support.deprecation = :log
+
+ # Raise an error on page load if there are pending migrations.
+ config.active_record.migration_error = :page_load
+
+ # Highlight code that triggered database queries in logs.
+ config.active_record.verbose_query_logs = true
+
+ # Debug mode disables concatenation and preprocessing of assets.
+ # This option may cause significant delays in view rendering with a large
+ # number of complex assets.
+ config.assets.debug = true
+
+ # Suppress logger output for asset requests.
+ config.assets.quiet = true
+
+ # Raises error for missing translations.
+ # config.action_view.raise_on_missing_translations = true
+
+ # Use an evented file watcher to asynchronously detect changes in source code,
+ # routes, locales, etc. This feature depends on the listen gem.
+ config.file_watcher = ActiveSupport::EventedFileUpdateChecker
+end
diff --git a/example/rails-60/config/environments/test.rb b/example/rails-60/config/environments/test.rb
new file mode 100644
index 000000000..0cb24249b
--- /dev/null
+++ b/example/rails-60/config/environments/test.rb
@@ -0,0 +1,49 @@
+# The test environment is used exclusively to run your application's
+# test suite. You never need to work with it otherwise. Remember that
+# your test database is "scratch space" for the test suite and is wiped
+# and recreated between test runs. Don't rely on the data there!
+
+Rails.application.configure do
+ # Settings specified here will take precedence over those in config/application.rb.
+
+ config.cache_classes = false
+ config.action_view.cache_template_loading = true
+
+ # Do not eager load code on boot. This avoids loading your whole application
+ # just for the purpose of running a single test. If you are using a tool that
+ # preloads Rails for running tests, you may have to set it to true.
+ config.eager_load = false
+
+ # Configure public file server for tests with Cache-Control for performance.
+ config.public_file_server.enabled = true
+ config.public_file_server.headers = {
+ 'Cache-Control' => "public, max-age=#{1.hour.to_i}"
+ }
+
+ # Show full error reports and disable caching.
+ config.consider_all_requests_local = true
+ config.action_controller.perform_caching = false
+ config.cache_store = :null_store
+
+ # Raise exceptions instead of rendering exception templates.
+ config.action_dispatch.show_exceptions = false
+
+ # Disable request forgery protection in test environment.
+ config.action_controller.allow_forgery_protection = false
+
+ # Store uploaded files on the local file system in a temporary directory.
+ config.active_storage.service = :test
+
+ config.action_mailer.perform_caching = false
+
+ # Tell Action Mailer not to deliver emails to the real world.
+ # The :test delivery method accumulates sent emails in the
+ # ActionMailer::Base.deliveries array.
+ config.action_mailer.delivery_method = :test
+
+ # Print deprecation notices to the stderr.
+ config.active_support.deprecation = :stderr
+
+ # Raises error for missing translations.
+ # config.action_view.raise_on_missing_translations = true
+end
diff --git a/example/rails-60/config/initializers/application_controller_renderer.rb b/example/rails-60/config/initializers/application_controller_renderer.rb
new file mode 100644
index 000000000..89d2efab2
--- /dev/null
+++ b/example/rails-60/config/initializers/application_controller_renderer.rb
@@ -0,0 +1,8 @@
+# Be sure to restart your server when you modify this file.
+
+# ActiveSupport::Reloader.to_prepare do
+# ApplicationController.renderer.defaults.merge!(
+# http_host: 'example.org',
+# https: false
+# )
+# end
diff --git a/example/rails-60/config/initializers/assets.rb b/example/rails-60/config/initializers/assets.rb
new file mode 100644
index 000000000..4b828e80c
--- /dev/null
+++ b/example/rails-60/config/initializers/assets.rb
@@ -0,0 +1,14 @@
+# Be sure to restart your server when you modify this file.
+
+# Version of your assets, change this if you want to expire all your assets.
+Rails.application.config.assets.version = '1.0'
+
+# Add additional assets to the asset load path.
+# Rails.application.config.assets.paths << Emoji.images_path
+# Add Yarn node_modules folder to the asset load path.
+Rails.application.config.assets.paths << Rails.root.join('node_modules')
+
+# Precompile additional assets.
+# application.js, application.css, and all non-JS/CSS in the app/assets
+# folder are already added.
+# Rails.application.config.assets.precompile += %w( admin.js admin.css )
diff --git a/example/rails-60/config/initializers/backtrace_silencers.rb b/example/rails-60/config/initializers/backtrace_silencers.rb
new file mode 100644
index 000000000..59385cdf3
--- /dev/null
+++ b/example/rails-60/config/initializers/backtrace_silencers.rb
@@ -0,0 +1,7 @@
+# Be sure to restart your server when you modify this file.
+
+# You can add backtrace silencers for libraries that you're using but don't wish to see in your backtraces.
+# Rails.backtrace_cleaner.add_silencer { |line| line =~ /my_noisy_library/ }
+
+# You can also remove all the silencers if you're trying to debug a problem that might stem from framework code.
+# Rails.backtrace_cleaner.remove_silencers!
diff --git a/example/rails-60/config/initializers/bugsnag.rb b/example/rails-60/config/initializers/bugsnag.rb
new file mode 100644
index 000000000..58c57fbf6
--- /dev/null
+++ b/example/rails-60/config/initializers/bugsnag.rb
@@ -0,0 +1,3 @@
+Bugsnag.configure do |config|
+ config.api_key = "YOUR_API_KEY_HERE"
+end
diff --git a/example/rails-60/config/initializers/content_security_policy.rb b/example/rails-60/config/initializers/content_security_policy.rb
new file mode 100644
index 000000000..35d0f26fc
--- /dev/null
+++ b/example/rails-60/config/initializers/content_security_policy.rb
@@ -0,0 +1,30 @@
+# Be sure to restart your server when you modify this file.
+
+# Define an application-wide content security policy
+# For further information see the following documentation
+# https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy
+
+# Rails.application.config.content_security_policy do |policy|
+# policy.default_src :self, :https
+# policy.font_src :self, :https, :data
+# policy.img_src :self, :https, :data
+# policy.object_src :none
+# policy.script_src :self, :https
+# policy.style_src :self, :https
+# # If you are using webpack-dev-server then specify webpack-dev-server host
+# policy.connect_src :self, :https, "http://localhost:3035", "ws://localhost:3035" if Rails.env.development?
+
+# # Specify URI for violation reports
+# # policy.report_uri "/csp-violation-report-endpoint"
+# end
+
+# If you are using UJS then enable automatic nonce generation
+# Rails.application.config.content_security_policy_nonce_generator = -> request { SecureRandom.base64(16) }
+
+# Set the nonce only to specific directives
+# Rails.application.config.content_security_policy_nonce_directives = %w(script-src)
+
+# Report CSP violations to a specified URI
+# For further information see the following documentation:
+# https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy-Report-Only
+# Rails.application.config.content_security_policy_report_only = true
diff --git a/example/rails-60/config/initializers/cookies_serializer.rb b/example/rails-60/config/initializers/cookies_serializer.rb
new file mode 100644
index 000000000..5a6a32d37
--- /dev/null
+++ b/example/rails-60/config/initializers/cookies_serializer.rb
@@ -0,0 +1,5 @@
+# Be sure to restart your server when you modify this file.
+
+# Specify a serializer for the signed and encrypted cookie jars.
+# Valid options are :json, :marshal, and :hybrid.
+Rails.application.config.action_dispatch.cookies_serializer = :json
diff --git a/example/rails-60/config/initializers/filter_parameter_logging.rb b/example/rails-60/config/initializers/filter_parameter_logging.rb
new file mode 100644
index 000000000..4a994e1e7
--- /dev/null
+++ b/example/rails-60/config/initializers/filter_parameter_logging.rb
@@ -0,0 +1,4 @@
+# Be sure to restart your server when you modify this file.
+
+# Configure sensitive parameters which will be filtered from the log file.
+Rails.application.config.filter_parameters += [:password]
diff --git a/example/rails-60/config/initializers/inflections.rb b/example/rails-60/config/initializers/inflections.rb
new file mode 100644
index 000000000..ac033bf9d
--- /dev/null
+++ b/example/rails-60/config/initializers/inflections.rb
@@ -0,0 +1,16 @@
+# Be sure to restart your server when you modify this file.
+
+# Add new inflection rules using the following format. Inflections
+# are locale specific, and you may define rules for as many different
+# locales as you wish. All of these examples are active by default:
+# ActiveSupport::Inflector.inflections(:en) do |inflect|
+# inflect.plural /^(ox)$/i, '\1en'
+# inflect.singular /^(ox)en/i, '\1'
+# inflect.irregular 'person', 'people'
+# inflect.uncountable %w( fish sheep )
+# end
+
+# These inflection rules are supported but not enabled by default:
+# ActiveSupport::Inflector.inflections(:en) do |inflect|
+# inflect.acronym 'RESTful'
+# end
diff --git a/example/rails-60/config/initializers/mime_types.rb b/example/rails-60/config/initializers/mime_types.rb
new file mode 100644
index 000000000..dc1899682
--- /dev/null
+++ b/example/rails-60/config/initializers/mime_types.rb
@@ -0,0 +1,4 @@
+# Be sure to restart your server when you modify this file.
+
+# Add new mime types for use in respond_to blocks:
+# Mime::Type.register "text/richtext", :rtf
diff --git a/example/rails-60/config/initializers/wrap_parameters.rb b/example/rails-60/config/initializers/wrap_parameters.rb
new file mode 100644
index 000000000..bbfc3961b
--- /dev/null
+++ b/example/rails-60/config/initializers/wrap_parameters.rb
@@ -0,0 +1,14 @@
+# Be sure to restart your server when you modify this file.
+
+# This file contains settings for ActionController::ParamsWrapper which
+# is enabled by default.
+
+# Enable parameter wrapping for JSON. You can disable this by setting :format to an empty array.
+ActiveSupport.on_load(:action_controller) do
+ wrap_parameters format: [:json]
+end
+
+# To enable root element in JSON for ActiveRecord objects.
+# ActiveSupport.on_load(:active_record) do
+# self.include_root_in_json = true
+# end
diff --git a/example/rails-60/config/locales/en.yml b/example/rails-60/config/locales/en.yml
new file mode 100644
index 000000000..cf9b342d0
--- /dev/null
+++ b/example/rails-60/config/locales/en.yml
@@ -0,0 +1,33 @@
+# Files in the config/locales directory are used for internationalization
+# and are automatically loaded by Rails. If you want to use locales other
+# than English, add the necessary files in this directory.
+#
+# To use the locales, use `I18n.t`:
+#
+# I18n.t 'hello'
+#
+# In views, this is aliased to just `t`:
+#
+# <%= t('hello') %>
+#
+# To use a different locale, set it with `I18n.locale`:
+#
+# I18n.locale = :es
+#
+# This would use the information in config/locales/es.yml.
+#
+# The following keys must be escaped otherwise they will not be retrieved by
+# the default I18n backend:
+#
+# true, false, on, off, yes, no
+#
+# Instead, surround them with single quotes.
+#
+# en:
+# 'true': 'foo'
+#
+# To learn more, please read the Rails Internationalization guide
+# available at https://guides.rubyonrails.org/i18n.html.
+
+en:
+ hello: "Hello world"
diff --git a/example/rails-60/config/puma.rb b/example/rails-60/config/puma.rb
new file mode 100644
index 000000000..5ed443774
--- /dev/null
+++ b/example/rails-60/config/puma.rb
@@ -0,0 +1,38 @@
+# Puma can serve each request in a thread from an internal thread pool.
+# The `threads` method setting takes two numbers: a minimum and maximum.
+# Any libraries that use thread pools should be configured to match
+# the maximum value specified for Puma. Default is set to 5 threads for minimum
+# and maximum; this matches the default thread size of Active Record.
+#
+max_threads_count = ENV.fetch("RAILS_MAX_THREADS") { 5 }
+min_threads_count = ENV.fetch("RAILS_MIN_THREADS") { max_threads_count }
+threads min_threads_count, max_threads_count
+
+# Specifies the `port` that Puma will listen on to receive requests; default is 3000.
+#
+port ENV.fetch("PORT") { 3000 }
+
+# Specifies the `environment` that Puma will run in.
+#
+environment ENV.fetch("RAILS_ENV") { "development" }
+
+# Specifies the `pidfile` that Puma will use.
+pidfile ENV.fetch("PIDFILE") { "tmp/pids/server.pid" }
+
+# Specifies the number of `workers` to boot in clustered mode.
+# Workers are forked web server processes. If using threads and workers together
+# the concurrency of the application would be max `threads` * `workers`.
+# Workers do not work on JRuby or Windows (both of which do not support
+# processes).
+#
+# workers ENV.fetch("WEB_CONCURRENCY") { 2 }
+
+# Use the `preload_app!` method when specifying a `workers` number.
+# This directive tells Puma to first boot the application and load code
+# before forking the application. This takes advantage of Copy On Write
+# process behavior so workers use less memory.
+#
+# preload_app!
+
+# Allow puma to be restarted by `rails restart` command.
+plugin :tmp_restart
diff --git a/example/rails-60/config/routes.rb b/example/rails-60/config/routes.rb
new file mode 100644
index 000000000..b5f1747c3
--- /dev/null
+++ b/example/rails-60/config/routes.rb
@@ -0,0 +1,27 @@
+Rails.application.routes.draw do
+ # Vanilla rails routing
+ get '/', to: 'application#index'
+ get '/crash', to: 'application#crash'
+ get '/crash_with_callback', to: 'application#callback'
+ get '/notify', to: 'application#notify'
+ get '/notify_data', to: 'application#data'
+ get '/notify_severity', to: 'application#severity'
+
+ # Sidekiq routing
+ get '/sidekiq', to: 'sidekiq#index'
+ get '/sidekiq/crash', to: 'sidekiq#crash'
+ get '/sidekiq/notify_data', to: 'sidekiq#metadata'
+ get '/sidekiq/crash_with_callback', to: 'sidekiq#callbacks'
+
+ # Que routing
+ get '/que', to: 'que#index'
+ get '/que/crash', to: 'que#crash'
+ get '/que/notify_data', to: 'que#metadata'
+ get '/que/crash_with_callback', to: 'que#callbacks'
+
+ # Resque routing
+ get '/resque', to: 'resque#index'
+ get '/resque/crash', to: 'resque#crash'
+ get '/resque/crash_with_callback', to: 'resque#callbacks'
+ get '/resque/notify_data', to: 'resque#metadata'
+end
diff --git a/example/rails-60/config/spring.rb b/example/rails-60/config/spring.rb
new file mode 100644
index 000000000..db5bf1307
--- /dev/null
+++ b/example/rails-60/config/spring.rb
@@ -0,0 +1,6 @@
+Spring.watch(
+ ".ruby-version",
+ ".rbenv-vars",
+ "tmp/restart.txt",
+ "tmp/caching-dev.txt"
+)
diff --git a/example/rails-60/config/storage.yml b/example/rails-60/config/storage.yml
new file mode 100644
index 000000000..d32f76e8f
--- /dev/null
+++ b/example/rails-60/config/storage.yml
@@ -0,0 +1,34 @@
+test:
+ service: Disk
+ root: <%= Rails.root.join("tmp/storage") %>
+
+local:
+ service: Disk
+ root: <%= Rails.root.join("storage") %>
+
+# Use rails credentials:edit to set the AWS secrets (as aws:access_key_id|secret_access_key)
+# amazon:
+# service: S3
+# access_key_id: <%= Rails.application.credentials.dig(:aws, :access_key_id) %>
+# secret_access_key: <%= Rails.application.credentials.dig(:aws, :secret_access_key) %>
+# region: us-east-1
+# bucket: your_own_bucket
+
+# Remember not to checkin your GCS keyfile to a repository
+# google:
+# service: GCS
+# project: your_project
+# credentials: <%= Rails.root.join("path/to/gcs.keyfile") %>
+# bucket: your_own_bucket
+
+# Use rails credentials:edit to set the Azure Storage secret (as azure_storage:storage_access_key)
+# microsoft:
+# service: AzureStorage
+# storage_account_name: your_account_name
+# storage_access_key: <%= Rails.application.credentials.dig(:azure_storage, :storage_access_key) %>
+# container: your_container_name
+
+# mirror:
+# service: Mirror
+# primary: local
+# mirrors: [ amazon, google, microsoft ]
diff --git a/example/rails-60/db/seeds.rb b/example/rails-60/db/seeds.rb
new file mode 100644
index 000000000..1beea2acc
--- /dev/null
+++ b/example/rails-60/db/seeds.rb
@@ -0,0 +1,7 @@
+# This file should contain all the record creation needed to seed the database with its default values.
+# The data can then be loaded with the rails db:seed command (or created alongside the database with db:setup).
+#
+# Examples:
+#
+# movies = Movie.create([{ name: 'Star Wars' }, { name: 'Lord of the Rings' }])
+# Character.create(name: 'Luke', movie: movies.first)
diff --git a/example/rails-60/lib/assets/.keep b/example/rails-60/lib/assets/.keep
new file mode 100644
index 000000000..e69de29bb
diff --git a/example/rails-60/lib/tasks/resque:setup.rake b/example/rails-60/lib/tasks/resque:setup.rake
new file mode 100644
index 000000000..1c97b45ea
--- /dev/null
+++ b/example/rails-60/lib/tasks/resque:setup.rake
@@ -0,0 +1,5 @@
+require 'resque/tasks'
+
+task 'resque:setup' => :environment do
+ require './app/workers/resque_workers'
+end
diff --git a/example/rails-60/log/.keep b/example/rails-60/log/.keep
new file mode 100644
index 000000000..e69de29bb
diff --git a/example/rails-60/public/404.html b/example/rails-60/public/404.html
new file mode 100644
index 000000000..2be3af26f
--- /dev/null
+++ b/example/rails-60/public/404.html
@@ -0,0 +1,67 @@
+
+
+
+ The page you were looking for doesn't exist (404)
+
+
+
+
+
+
+
+
+
The page you were looking for doesn't exist.
+
You may have mistyped the address or the page may have moved.
+
+
If you are the application owner check the logs for more information.
+
+
+
diff --git a/example/rails-60/public/422.html b/example/rails-60/public/422.html
new file mode 100644
index 000000000..c08eac0d1
--- /dev/null
+++ b/example/rails-60/public/422.html
@@ -0,0 +1,67 @@
+
+
+
+ The change you wanted was rejected (422)
+
+
+
+
+
+
+
+
+
The change you wanted was rejected.
+
Maybe you tried to change something you didn't have access to.
+
+
If you are the application owner check the logs for more information.
+
+
+
diff --git a/example/rails-60/public/500.html b/example/rails-60/public/500.html
new file mode 100644
index 000000000..78a030af2
--- /dev/null
+++ b/example/rails-60/public/500.html
@@ -0,0 +1,66 @@
+
+
+
+ We're sorry, but something went wrong (500)
+
+
+
+
+
+
+
+
+
We're sorry, but something went wrong.
+
+
If you are the application owner check the logs for more information.
+
+
+
diff --git a/example/rails-60/public/apple-touch-icon-precomposed.png b/example/rails-60/public/apple-touch-icon-precomposed.png
new file mode 100644
index 000000000..e69de29bb
diff --git a/example/rails-60/public/apple-touch-icon.png b/example/rails-60/public/apple-touch-icon.png
new file mode 100644
index 000000000..e69de29bb
diff --git a/example/rails-60/public/favicon.ico b/example/rails-60/public/favicon.ico
new file mode 100644
index 000000000..e69de29bb
diff --git a/example/rails-60/public/robots.txt b/example/rails-60/public/robots.txt
new file mode 100644
index 000000000..c19f78ab6
--- /dev/null
+++ b/example/rails-60/public/robots.txt
@@ -0,0 +1 @@
+# See https://www.robotstxt.org/robotstxt.html for documentation on how to use the robots.txt file
diff --git a/example/rails-60/public/style.css b/example/rails-60/public/style.css
new file mode 100644
index 000000000..253bee2aa
--- /dev/null
+++ b/example/rails-60/public/style.css
@@ -0,0 +1,34 @@
+body {
+ font-family: -apple-system, BlinkMacSystemFont, Segoe UI, Helvetica, Arial, sans-serif, Apple Color Emoji, Segoe UI Emoji;
+ max-width: 80ch;
+ margin: 0 auto;
+}
+
+pre,
+code {
+ font-family: SFMono-Regular, Consolas, Liberation Mono, Menlo, monospace;
+}
+
+pre {
+ background: rgba(0, 0, 0, .05);
+ border: 1px solid rgba(0, 0, 0, .1);
+ padding: 1rem;
+}
+
+pre.shell::before {
+ content: '$ ';
+ pointer-events: none;
+}
+
+a:link,
+a:visited {
+ color: #536eec;
+}
+
+a:hover {
+ opacity: .7;
+}
+
+.upper {
+ text-transform: uppercase;
+}
diff --git a/example/rails-60/storage/.keep b/example/rails-60/storage/.keep
new file mode 100644
index 000000000..e69de29bb
diff --git a/example/rails-60/tmp/.keep b/example/rails-60/tmp/.keep
new file mode 100644
index 000000000..e69de29bb
diff --git a/example/rails-60/tmp/pids/.keep b/example/rails-60/tmp/pids/.keep
new file mode 100644
index 000000000..e69de29bb
diff --git a/features/fixtures/rails3/app/config/initializers/bugsnag.rb b/features/fixtures/rails3/app/config/initializers/bugsnag.rb
index fea970a97..b849c0995 100644
--- a/features/fixtures/rails3/app/config/initializers/bugsnag.rb
+++ b/features/fixtures/rails3/app/config/initializers/bugsnag.rb
@@ -11,10 +11,11 @@
config.release_stage = ENV["BUGSNAG_RELEASE_STAGE"] if ENV.include? "BUGSNAG_RELEASE_STAGE"
config.send_code = ENV["BUGSNAG_SEND_CODE"] != "false"
config.send_environment = ENV["BUGSNAG_SEND_ENVIRONMENT"] == "true"
+ config.meta_data_filters << 'filtered_parameter'
if ENV["SQL_ONLY_BREADCRUMBS"] == "true"
config.before_breadcrumb_callbacks << Proc.new do |breadcrumb|
breadcrumb.ignore! unless breadcrumb.meta_data[:event_name] == "sql.active_record" && breadcrumb.meta_data[:name] == "User Load"
end
end
-end
\ No newline at end of file
+end
diff --git a/features/fixtures/rails4/app/config/initializers/bugsnag.rb b/features/fixtures/rails4/app/config/initializers/bugsnag.rb
index d7ce3b9b3..b849c0995 100644
--- a/features/fixtures/rails4/app/config/initializers/bugsnag.rb
+++ b/features/fixtures/rails4/app/config/initializers/bugsnag.rb
@@ -11,6 +11,7 @@
config.release_stage = ENV["BUGSNAG_RELEASE_STAGE"] if ENV.include? "BUGSNAG_RELEASE_STAGE"
config.send_code = ENV["BUGSNAG_SEND_CODE"] != "false"
config.send_environment = ENV["BUGSNAG_SEND_ENVIRONMENT"] == "true"
+ config.meta_data_filters << 'filtered_parameter'
if ENV["SQL_ONLY_BREADCRUMBS"] == "true"
config.before_breadcrumb_callbacks << Proc.new do |breadcrumb|
diff --git a/features/fixtures/rails5/app/config/initializers/bugsnag.rb b/features/fixtures/rails5/app/config/initializers/bugsnag.rb
index d7ce3b9b3..b849c0995 100644
--- a/features/fixtures/rails5/app/config/initializers/bugsnag.rb
+++ b/features/fixtures/rails5/app/config/initializers/bugsnag.rb
@@ -11,6 +11,7 @@
config.release_stage = ENV["BUGSNAG_RELEASE_STAGE"] if ENV.include? "BUGSNAG_RELEASE_STAGE"
config.send_code = ENV["BUGSNAG_SEND_CODE"] != "false"
config.send_environment = ENV["BUGSNAG_SEND_ENVIRONMENT"] == "true"
+ config.meta_data_filters << 'filtered_parameter'
if ENV["SQL_ONLY_BREADCRUMBS"] == "true"
config.before_breadcrumb_callbacks << Proc.new do |breadcrumb|
diff --git a/features/fixtures/rails6/app/config/initializers/bugsnag.rb b/features/fixtures/rails6/app/config/initializers/bugsnag.rb
index d7ce3b9b3..b849c0995 100644
--- a/features/fixtures/rails6/app/config/initializers/bugsnag.rb
+++ b/features/fixtures/rails6/app/config/initializers/bugsnag.rb
@@ -11,6 +11,7 @@
config.release_stage = ENV["BUGSNAG_RELEASE_STAGE"] if ENV.include? "BUGSNAG_RELEASE_STAGE"
config.send_code = ENV["BUGSNAG_SEND_CODE"] != "false"
config.send_environment = ENV["BUGSNAG_SEND_ENVIRONMENT"] == "true"
+ config.meta_data_filters << 'filtered_parameter'
if ENV["SQL_ONLY_BREADCRUMBS"] == "true"
config.before_breadcrumb_callbacks << Proc.new do |breadcrumb|
diff --git a/features/rails_features/meta_data_filters.feature b/features/rails_features/meta_data_filters.feature
index fc6b4a8f6..b867e63e7 100644
--- a/features/rails_features/meta_data_filters.feature
+++ b/features/rails_features/meta_data_filters.feature
@@ -3,12 +3,14 @@ Feature: Metadata filters
@rails3 @rails4 @rails5 @rails6
Scenario: Meta_data_filters should include Rails.configuration.filter_parameters
Given I start the rails service
- When I navigate to the route "/metadata_filters/filter" on the rails app
+ When I navigate to the route "/metadata_filters/filter?filtered_parameter=foo&other_parameter=bar" on the rails app
And I wait to receive a request
Then the request is valid for the error reporting API version "4.0" for the "Ruby Bugsnag Notifier"
And the event "unhandled" is false
And the exception "errorClass" equals "RuntimeError"
And the exception "message" starts with "handled string"
And the event "app.type" equals "rails"
- And the event "metaData.request.url" ends with "/metadata_filters/filter"
+ And the event "metaData.request.url" ends with "/metadata_filters/filter?filtered_parameter=[FILTERED]&other_parameter=bar"
And the event "metaData.my_specific_filter" equals "[FILTERED]"
+ And the event "metaData.request.params.filtered_parameter" equals "[FILTERED]"
+ And the event "metaData.request.params.other_parameter" equals "bar"
diff --git a/lib/bugsnag.rb b/lib/bugsnag.rb
index b20f3c5e0..1be5d084a 100644
--- a/lib/bugsnag.rb
+++ b/lib/bugsnag.rb
@@ -33,6 +33,7 @@
require "bugsnag/breadcrumbs/breadcrumb"
require "bugsnag/breadcrumbs/breadcrumbs"
+# rubocop:todo Metrics/ModuleLength
module Bugsnag
LOCK = Mutex.new
INTEGRATIONS = [:resque, :sidekiq, :mailman, :delayed_job, :shoryuken, :que, :mongo]
@@ -63,7 +64,7 @@ def notify(exception, auto_notify=false, &block)
auto_notify = false
end
- return unless deliver_notification?(exception, auto_notify)
+ return unless should_deliver_notification?(exception, auto_notify)
exception = NIL_EXCEPTION_DESCRIPTION if exception.nil?
@@ -71,6 +72,7 @@ def notify(exception, auto_notify=false, &block)
# If this is an auto_notify we yield the block before the any middleware is run
yield(report) if block_given? && auto_notify
+
if report.ignore?
configuration.debug("Not notifying #{report.exceptions.last[:errorClass]} due to ignore being signified in auto_notify block")
return
@@ -97,6 +99,7 @@ def notify(exception, auto_notify=false, &block)
# If this is not an auto_notify then the block was provided by the user. This should be the last
# block that is run as it is the users "most specific" block.
yield(report) if block_given? && !auto_notify
+
if report.ignore?
configuration.debug("Not notifying #{report.exceptions.last[:errorClass]} due to ignore being signified in user provided block")
return
@@ -111,13 +114,7 @@ def notify(exception, auto_notify=false, &block)
report.severity_reason = initial_reason
end
- # Deliver
- configuration.info("Notifying #{configuration.notify_endpoint} of #{report.exceptions.last[:errorClass]}")
- options = {:headers => report.headers}
- payload = ::JSON.dump(Bugsnag::Helpers.trim_if_needed(report.as_json))
- Bugsnag::Delivery[configuration.delivery_method].deliver(configuration.notify_endpoint, payload, configuration, options)
- report_summary = report.summary
- leave_breadcrumb(report_summary[:error_class], report_summary, Bugsnag::Breadcrumbs::ERROR_BREADCRUMB_TYPE, :auto)
+ deliver_notification(report)
end
end
@@ -147,6 +144,7 @@ def at_exit_handler_installed?
# Configuration getters
##
# Returns the client's Configuration object, or creates one if not yet created.
+ # @return [Configuration]
def configuration
@configuration = nil unless defined?(@configuration)
@configuration || LOCK.synchronize { @configuration ||= Bugsnag::Configuration.new }
@@ -211,27 +209,40 @@ def leave_breadcrumb(name, meta_data={}, type=Bugsnag::Breadcrumbs::MANUAL_BREAD
validator.validate(breadcrumb)
# Skip if it's already invalid
- unless breadcrumb.ignore?
- # Run callbacks
- configuration.before_breadcrumb_callbacks.each do |c|
- c.arity > 0 ? c.call(breadcrumb) : c.call
- break if breadcrumb.ignore?
- end
+ return if breadcrumb.ignore?
- # Return early if ignored
- return if breadcrumb.ignore?
+ # Run callbacks
+ configuration.before_breadcrumb_callbacks.each do |c|
+ c.arity > 0 ? c.call(breadcrumb) : c.call
+ break if breadcrumb.ignore?
+ end
+
+ # Return early if ignored
+ return if breadcrumb.ignore?
- # Validate again in case of callback alteration
- validator.validate(breadcrumb)
+ # Validate again in case of callback alteration
+ validator.validate(breadcrumb)
- # Add to breadcrumbs buffer if still valid
- configuration.breadcrumbs << breadcrumb unless breadcrumb.ignore?
+ # Add to breadcrumbs buffer if still valid
+ configuration.breadcrumbs << breadcrumb unless breadcrumb.ignore?
+ end
+
+ ##
+ # Returns the client's Cleaner object, or creates one if not yet created.
+ #
+ # @api private
+ #
+ # @return [Cleaner]
+ def cleaner
+ @cleaner = nil unless defined?(@cleaner)
+ @cleaner || LOCK.synchronize do
+ @cleaner ||= Bugsnag::Cleaner.new(configuration)
end
end
private
- def deliver_notification?(exception, auto_notify)
+ def should_deliver_notification?(exception, auto_notify)
reason = abort_reason(exception, auto_notify)
configuration.debug(reason) unless reason.nil?
reason.nil?
@@ -249,6 +260,32 @@ def abort_reason(exception, auto_notify)
end
end
+ ##
+ # Deliver the notification to Bugsnag
+ #
+ # @param report [Report]
+ # @return void
+ def deliver_notification(report)
+ configuration.info("Notifying #{configuration.notify_endpoint} of #{report.exceptions.last[:errorClass]}")
+
+ payload = report_to_json(report)
+ options = {:headers => report.headers}
+
+ Bugsnag::Delivery[configuration.delivery_method].deliver(
+ configuration.notify_endpoint,
+ payload,
+ configuration,
+ options
+ )
+
+ leave_breadcrumb(
+ report.summary[:error_class],
+ report.summary,
+ Bugsnag::Breadcrumbs::ERROR_BREADCRUMB_TYPE,
+ :auto
+ )
+ end
+
# Check if the API key is valid and warn (once) if it is not
def check_key_valid
@key_warning = false unless defined?(@key_warning)
@@ -273,7 +310,23 @@ def check_endpoint_setup
raise ArgumentError, "The session endpoint cannot be modified without the notify endpoint"
end
end
+
+ ##
+ # Convert the Report object to JSON
+ #
+ # We ensure the report is safe to send by removing recursion, fixing
+ # encoding errors and redacting metadata according to "meta_data_filters"
+ #
+ # @param report [Report]
+ # @return string
+ def report_to_json(report)
+ cleaned = cleaner.clean_object(report.as_json)
+ trimmed = Bugsnag::Helpers.trim_if_needed(cleaned)
+
+ ::JSON.dump(trimmed)
+ end
end
end
+# rubocop:enable Metrics/ModuleLength
Bugsnag.load_integrations unless ENV["BUGSNAG_DISABLE_AUTOCONFIGURE"]
diff --git a/lib/bugsnag/breadcrumbs/breadcrumbs.rb b/lib/bugsnag/breadcrumbs/breadcrumbs.rb
index 24f140e1d..69506d29d 100644
--- a/lib/bugsnag/breadcrumbs/breadcrumbs.rb
+++ b/lib/bugsnag/breadcrumbs/breadcrumbs.rb
@@ -1,6 +1,4 @@
module Bugsnag::Breadcrumbs
- MAX_NAME_LENGTH = 30
-
VALID_BREADCRUMB_TYPES = [
ERROR_BREADCRUMB_TYPE = "error",
MANUAL_BREADCRUMB_TYPE = "manual",
diff --git a/lib/bugsnag/breadcrumbs/validator.rb b/lib/bugsnag/breadcrumbs/validator.rb
index c6893b50a..d1f559492 100644
--- a/lib/bugsnag/breadcrumbs/validator.rb
+++ b/lib/bugsnag/breadcrumbs/validator.rb
@@ -15,12 +15,6 @@ def initialize(configuration)
#
# @param breadcrumb [Bugsnag::Breadcrumbs::Breadcrumb] the breadcrumb to be validated
def validate(breadcrumb)
- # Check name length
- if breadcrumb.name.size > Bugsnag::Breadcrumbs::MAX_NAME_LENGTH
- @configuration.debug("Breadcrumb name trimmed to length #{Bugsnag::Breadcrumbs::MAX_NAME_LENGTH}. Original name: #{breadcrumb.name}")
- breadcrumb.name = breadcrumb.name.slice(0...Bugsnag::Breadcrumbs::MAX_NAME_LENGTH)
- end
-
# Check meta_data hash doesn't contain complex values
breadcrumb.meta_data = breadcrumb.meta_data.select do |k, v|
if valid_meta_data_type?(v)
diff --git a/lib/bugsnag/cleaner.rb b/lib/bugsnag/cleaner.rb
index ea7539d86..b33d06600 100644
--- a/lib/bugsnag/cleaner.rb
+++ b/lib/bugsnag/cleaner.rb
@@ -1,19 +1,76 @@
require 'uri'
module Bugsnag
+ # @api private
class Cleaner
FILTERED = '[FILTERED]'.freeze
RECURSION = '[RECURSION]'.freeze
OBJECT = '[OBJECT]'.freeze
RAISED = '[RAISED]'.freeze
+ OBJECT_WITH_ID_AND_CLASS = '[OBJECT]: [Class]: %s [ID]: %d'.freeze
- def initialize(filters)
- @filters = Array(filters)
- @deep_filters = @filters.any? {|f| f.kind_of?(Regexp) && f.to_s.include?("\\.".freeze) }
+ ##
+ # @param configuration [Configuration]
+ def initialize(configuration)
+ @configuration = configuration
end
- def clean_object(obj)
- traverse_object(obj, {}, nil)
+ def clean_object(object)
+ @deep_filters = deep_filters?
+
+ traverse_object(object, {}, nil)
+ end
+
+ ##
+ # @param url [String]
+ # @return [String]
+ def clean_url(url)
+ return url if @configuration.meta_data_filters.empty?
+
+ uri = URI(url)
+ return url unless uri.query
+
+ query_params = uri.query.split('&').map { |pair| pair.split('=') }
+ query_params.map! do |key, val|
+ if filters_match?(key)
+ "#{key}=#{FILTERED}"
+ else
+ "#{key}=#{val}"
+ end
+ end
+
+ uri.query = query_params.join('&')
+ uri.to_s
+ end
+
+ private
+
+ ##
+ # This method calculates whether we need to filter deeply or not; i.e. whether
+ # we should match both with and without 'request.params'
+ #
+ # This is cached on the instance variable '@deep_filters' for performance
+ # reasons
+ #
+ # @return [Boolean]
+ def deep_filters?
+ @configuration.meta_data_filters.any? do |filter|
+ filter.is_a?(Regexp) && filter.to_s.include?("\\.".freeze)
+ end
+ end
+
+ 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', invalid: :replace, undef: :replace).encode('utf-8')
+ else
+ str.encode('utf-8', invalid: :replace, undef: :replace)
+ end
+ elsif defined?(Iconv)
+ Iconv.conv('UTF-8//IGNORE', 'UTF-8', str) || str
+ else
+ str
+ end
end
def traverse_object(obj, seen, scope)
@@ -28,12 +85,14 @@ def traverse_object(obj, seen, scope)
value = case obj
when Hash
clean_hash = {}
- obj.each do |k,v|
+ obj.each do |k, v|
begin
- if filters_match_deeply?(k, scope)
+ current_scope = [scope, k].compact.join('.')
+
+ if filters_match_deeply?(k, current_scope)
clean_hash[k] = FILTERED
else
- clean_hash[k] = traverse_object(v, seen, [scope, k].compact.join('.'))
+ clean_hash[k] = traverse_object(v, seen, current_scope)
end
# If we get an error here, we assume the key needs to be filtered
# to avoid leaking things we shouldn't. We also remove the key itself
@@ -63,7 +122,12 @@ def traverse_object(obj, seen, scope)
# avoid leaking potentially sensitive data from objects' #inspect output
if str =~ /#<.*>/
- OBJECT
+ # Use id of the object if available
+ if obj.respond_to?(:id)
+ format(OBJECT_WITH_ID_AND_CLASS, class_name: obj.class, id: obj.id)
+ else
+ OBJECT
+ end
else
clean_string(str)
end
@@ -73,67 +137,56 @@ def traverse_object(obj, seen, scope)
value
end
- 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', invalid: :replace, undef: :replace).encode('utf-8')
+ ##
+ # @param key [String, #to_s]
+ # @return [Boolean]
+ def filters_match?(key)
+ str = key.to_s
+
+ @configuration.meta_data_filters.any? do |filter|
+ case filter
+ when Regexp
+ str.match(filter)
else
- str.encode('utf-8', invalid: :replace, undef: :replace)
+ str.include?(filter.to_s)
end
- elsif defined?(Iconv)
- Iconv.conv('UTF-8//IGNORE', 'UTF-8', str) || str
- else
- str
end
end
- def self.clean_object_encoding(obj)
- new(nil).clean_object(obj)
- end
+ ##
+ # If someone has a Rails filter like /^stuff\.secret/, it won't match
+ # "request.params.stuff.secret", so we try it both with and without the
+ # "request.params." bit.
+ #
+ # @param key [String, #to_s]
+ # @param scope [String]
+ # @return [Boolean]
+ def filters_match_deeply?(key, scope)
+ return false unless scope_should_be_filtered?(scope)
- def clean_url(url)
- return url if @filters.empty?
+ return true if filters_match?(key)
+ return false unless @deep_filters
- uri = URI(url)
- return url unless uri.query
+ return true if filters_match?(scope)
- query_params = uri.query.split('&').map { |pair| pair.split('=') }
- query_params.map! do |key, val|
- if filters_match?(key)
- "#{key}=#{FILTERED}"
+ @configuration.scopes_to_filter.any? do |scope_to_filter|
+ if scope.start_with?("#{scope_to_filter}.request.params.")
+ filters_match?(scope.sub("#{scope_to_filter}.request.params.", ''))
else
- "#{key}=#{val}"
+ filters_match?(scope.sub("#{scope_to_filter}.", ''))
end
end
-
- uri.query = query_params.join('&')
- uri.to_s
end
- private
-
- def filters_match?(key)
- str = key.to_s
-
- @filters.any? do |f|
- case f
- when Regexp
- str.match(f)
- else
- str.include?(f.to_s)
- end
+ ##
+ # Should the given scope be filtered?
+ #
+ # @param scope [String]
+ # @return [Boolean]
+ def scope_should_be_filtered?(scope)
+ @configuration.scopes_to_filter.any? do |scope_to_filter|
+ scope.start_with?("#{scope_to_filter}.")
end
end
-
- # If someone has a Rails filter like /^stuff\.secret/, it won't match "request.params.stuff.secret",
- # so we try it both with and without the "request.params." bit.
- def filters_match_deeply?(key, scope)
- return true if filters_match?(key)
- return false unless @deep_filters
-
- long = [scope, key].compact.join('.')
- short = long.sub(/^request\.params\./, '')
- filters_match?(long) || filters_match?(short)
- end
end
end
diff --git a/lib/bugsnag/configuration.rb b/lib/bugsnag/configuration.rb
index 90a3fa2fb..d017c111e 100644
--- a/lib/bugsnag/configuration.rb
+++ b/lib/bugsnag/configuration.rb
@@ -3,6 +3,7 @@
require "logger"
require "bugsnag/middleware_stack"
require "bugsnag/middleware/callbacks"
+require "bugsnag/middleware/discard_error_class"
require "bugsnag/middleware/exception_meta_data"
require "bugsnag/middleware/ignore_error_class"
require "bugsnag/middleware/suggestion_data"
@@ -35,9 +36,13 @@ class Configuration
attr_accessor :timeout
attr_accessor :hostname
attr_accessor :runtime_versions
- attr_accessor :ignore_classes
+ attr_accessor :discard_classes
attr_accessor :auto_capture_sessions
+ ##
+ # @deprecated Use {#discard_classes} instead
+ attr_accessor :ignore_classes
+
##
# @return [String] URL error notifications will be delivered to
attr_reader :notify_endpoint
@@ -67,6 +72,10 @@ class Configuration
# @return [Regexp] matching file paths out of project
attr_accessor :vendor_path
+ ##
+ # @return [Array]
+ attr_reader :scopes_to_filter
+
API_KEY_REGEX = /[0-9a-f]{32}/i
THREAD_LOCAL_NAME = "bugsnag_req_data"
@@ -86,7 +95,9 @@ class Configuration
DEFAULT_MAX_BREADCRUMBS = 25
# Path to vendored code. Used to mark file paths as out of project.
- DEFAULT_VENDOR_PATH = %r{^(vendor\/|\.bundle\/)}
+ DEFAULT_VENDOR_PATH = %r{^(vendor/|\.bundle/)}
+
+ DEFAULT_SCOPES_TO_FILTER = ['events.metaData', 'events.breadcrumbs.metaData'].freeze
alias :track_sessions :auto_capture_sessions
alias :track_sessions= :auto_capture_sessions=
@@ -99,6 +110,7 @@ def initialize
self.send_environment = false
self.send_code = true
self.meta_data_filters = Set.new(DEFAULT_META_DATA_FILTERS)
+ self.scopes_to_filter = DEFAULT_SCOPES_TO_FILTER
self.hostname = default_hostname
self.runtime_versions = {}
self.runtime_versions["ruby"] = RUBY_VERSION
@@ -122,7 +134,10 @@ def initialize
# SystemExit and SignalException are common Exception types seen with
# successful exits and are not automatically reported to Bugsnag
+ # TODO move these defaults into `discard_classes` when `ignore_classes`
+ # is removed
self.ignore_classes = Set.new([SystemExit, SignalException])
+ self.discard_classes = Set.new([])
# Read the API key from the environment
self.api_key = ENV["BUGSNAG_API_KEY"]
@@ -147,6 +162,7 @@ def initialize
# Configure the bugsnag middleware stack
self.internal_middleware = Bugsnag::MiddlewareStack.new
self.internal_middleware.use Bugsnag::Middleware::ExceptionMetaData
+ self.internal_middleware.use Bugsnag::Middleware::DiscardErrorClass
self.internal_middleware.use Bugsnag::Middleware::IgnoreErrorClass
self.internal_middleware.use Bugsnag::Middleware::SuggestionData
self.internal_middleware.use Bugsnag::Middleware::ClassifyError
@@ -304,6 +320,8 @@ def disable_sessions
private
+ attr_writer :scopes_to_filter
+
PROG_NAME = "[Bugsnag]"
def default_hostname
diff --git a/lib/bugsnag/helpers.rb b/lib/bugsnag/helpers.rb
index 99a3c2f21..21223f74a 100644
--- a/lib/bugsnag/helpers.rb
+++ b/lib/bugsnag/helpers.rb
@@ -17,12 +17,10 @@ module Helpers
def self.trim_if_needed(value)
value = "" if value.nil?
- # Sanitize object
- sanitized_value = Bugsnag::Cleaner.clean_object_encoding(value)
- return sanitized_value unless payload_too_long?(sanitized_value)
+ return value unless payload_too_long?(value)
# Trim metadata
- reduced_value = trim_metadata(sanitized_value)
+ reduced_value = trim_metadata(value)
return reduced_value unless payload_too_long?(reduced_value)
# Trim code from stacktrace
diff --git a/lib/bugsnag/middleware/discard_error_class.rb b/lib/bugsnag/middleware/discard_error_class.rb
new file mode 100644
index 000000000..1dff08ed6
--- /dev/null
+++ b/lib/bugsnag/middleware/discard_error_class.rb
@@ -0,0 +1,30 @@
+module Bugsnag::Middleware
+ ##
+ # Determines if the exception should be ignored based on the configured
+ # `discard_classes`
+ class DiscardErrorClass
+ ##
+ # @param middleware [#call] The next middleware to call
+ def initialize(middleware)
+ @middleware = middleware
+ end
+
+ ##
+ # @param report [Report]
+ def call(report)
+ should_discard = report.raw_exceptions.any? do |ex|
+ report.configuration.discard_classes.any? do |to_ignore|
+ case to_ignore
+ when String then to_ignore == ex.class.name
+ when Regexp then to_ignore =~ ex.class.name
+ else false
+ end
+ end
+ end
+
+ report.ignore! if should_discard
+
+ @middleware.call(report)
+ end
+ end
+end
diff --git a/lib/bugsnag/middleware/ignore_error_class.rb b/lib/bugsnag/middleware/ignore_error_class.rb
index 5d21a7d08..3ef5c996a 100644
--- a/lib/bugsnag/middleware/ignore_error_class.rb
+++ b/lib/bugsnag/middleware/ignore_error_class.rb
@@ -2,6 +2,8 @@ module Bugsnag::Middleware
##
# Determines if the exception should be ignored based on the configured
# `ignore_classes`
+ #
+ # @deprecated Use {DiscardErrorClass} instead
class IgnoreErrorClass
def initialize(bugsnag)
@bugsnag = bugsnag
diff --git a/lib/bugsnag/middleware/rack_request.rb b/lib/bugsnag/middleware/rack_request.rb
index 3a2a39719..6825ccf21 100644
--- a/lib/bugsnag/middleware/rack_request.rb
+++ b/lib/bugsnag/middleware/rack_request.rb
@@ -28,18 +28,16 @@ def call(report)
url = "#{request.scheme}://#{request.host}"
url << ":#{request.port}" unless [80, 443].include?(request.port)
- cleaner = Bugsnag::Cleaner.new(report.configuration.meta_data_filters)
-
# If app is passed a bad URL, this code will crash attempting to clean it
begin
- url << cleaner.clean_url(request.fullpath)
+ url << Bugsnag.cleaner.clean_url(request.fullpath)
rescue StandardError => stde
Bugsnag.configuration.warn "RackRequest - Rescued error while cleaning request.fullpath: #{stde}"
end
referer = nil
begin
- referer = cleaner.clean_url(request.referer) if request.referer
+ referer = Bugsnag.cleaner.clean_url(request.referer) if request.referer
rescue StandardError => stde
Bugsnag.configuration.warn "RackRequest - Rescued error while cleaning request.referer: #{stde}"
end
diff --git a/lib/bugsnag/report.rb b/lib/bugsnag/report.rb
index c3b1e54aa..66b3ed7fd 100644
--- a/lib/bugsnag/report.rb
+++ b/lib/bugsnag/report.rb
@@ -97,6 +97,7 @@ def as_json
releaseStage: release_stage,
type: app_type
},
+ breadcrumbs: breadcrumbs.map(&:to_h),
context: context,
device: {
hostname: hostname,
@@ -104,6 +105,7 @@ def as_json
},
exceptions: exceptions,
groupingHash: grouping_hash,
+ metaData: meta_data,
session: session,
severity: severity,
severityReason: severity_reason,
@@ -111,19 +113,7 @@ def as_json
user: user
}
- # cleanup character encodings
- payload_event = Bugsnag::Cleaner.clean_object_encoding(payload_event)
-
- # filter out sensitive values in (and cleanup encodings) metaData
- filter_cleaner = Bugsnag::Cleaner.new(configuration.meta_data_filters)
- payload_event[:metaData] = filter_cleaner.clean_object(meta_data)
- payload_event[:breadcrumbs] = breadcrumbs.map do |breadcrumb|
- breadcrumb_hash = breadcrumb.to_h
- breadcrumb_hash[:metaData] = filter_cleaner.clean_object(breadcrumb_hash[:metaData])
- breadcrumb_hash
- end
-
- payload_event.reject! {|k,v| v.nil? }
+ payload_event.reject! {|k, v| v.nil? }
# return the payload hash
{
diff --git a/lib/bugsnag/stacktrace.rb b/lib/bugsnag/stacktrace.rb
index 1eb0259e0..ac31bb535 100644
--- a/lib/bugsnag/stacktrace.rb
+++ b/lib/bugsnag/stacktrace.rb
@@ -9,27 +9,25 @@ class Stacktrace
##
# Process a backtrace and the configuration into a parsed stacktrace.
+ #
+ # rubocop:todo Metrics/CyclomaticComplexity
def initialize(backtrace, configuration)
@configuration = configuration
backtrace = caller if !backtrace || backtrace.empty?
@processed_backtrace = backtrace.map do |trace|
+ # Parse the stacktrace line
if trace.match(BACKTRACE_LINE_REGEX)
file, line_str, method = [$1, $2, $3]
elsif trace.match(JAVA_BACKTRACE_REGEX)
method, file, line_str = [$1, $2, $3]
end
- # Parse the stacktrace line
-
next(nil) if file.nil?
# Expand relative paths
- p = Pathname.new(file)
- if p.relative?
- file = p.realpath.to_s rescue file
- end
+ file = File.realpath(file) rescue file
# Generate the stacktrace line hash
trace_hash = {}
@@ -64,6 +62,7 @@ def initialize(backtrace, configuration)
end
end.compact
end
+ # rubocop:enable Metrics/CyclomaticComplexity
##
# Returns the processed backtrace
diff --git a/spec/breadcrumbs/breadcrumb_spec.rb b/spec/breadcrumbs/breadcrumb_spec.rb
index 3f315b327..acd3f72c2 100644
--- a/spec/breadcrumbs/breadcrumb_spec.rb
+++ b/spec/breadcrumbs/breadcrumb_spec.rb
@@ -90,4 +90,4 @@
)
end
end
-end
\ No newline at end of file
+end
diff --git a/spec/breadcrumbs/validator_spec.rb b/spec/breadcrumbs/validator_spec.rb
index 07e7b2c5b..581b243c3 100644
--- a/spec/breadcrumbs/validator_spec.rb
+++ b/spec/breadcrumbs/validator_spec.rb
@@ -31,31 +31,6 @@
validator.validate(breadcrumb)
end
- it "trims long messages to length and warns" do
- config = instance_double(Bugsnag::Configuration)
- allow(config).to receive(:enabled_automatic_breadcrumb_types).and_return(enabled_automatic_breadcrumb_types)
- validator = Bugsnag::Breadcrumbs::Validator.new(config)
-
- name = "1234567890123456789012345678901234567890"
-
- breadcrumb = instance_double(Bugsnag::Breadcrumbs::Breadcrumb, {
- :auto => auto,
- :name => name,
- :type => type,
- :meta_data => meta_data,
- :meta_data= => nil
- })
-
- expect(breadcrumb).to_not receive(:ignore!)
- expect(breadcrumb).to receive(:name=).with("123456789012345678901234567890")
- expected_string = "Breadcrumb name trimmed to length 30. Original name: #{name}"
- expect(config).to receive(:debug).with(expected_string)
-
- validator.validate(breadcrumb)
- # Check the original message has not been modified
- expect(name).to eq("1234567890123456789012345678901234567890")
- end
-
describe "tests meta_data types" do
it "accepts Strings, Numerics, Booleans, & nil" do
config = instance_double(Bugsnag::Configuration)
@@ -198,4 +173,4 @@ class TestClass
end
end
end
-end
\ No newline at end of file
+end
diff --git a/spec/bugsnag_spec.rb b/spec/bugsnag_spec.rb
index 73e4b1237..07cc6121d 100644
--- a/spec/bugsnag_spec.rb
+++ b/spec/bugsnag_spec.rb
@@ -268,7 +268,7 @@ module Kernel
)
expect(breadcrumbs.to_a.size).to eq(1)
expect(breadcrumbs.first.to_h).to match({
- :name => "123123123123123123123123123123",
+ :name => "123123123123123123123123123123456456456456456456456456456456",
:type => Bugsnag::Breadcrumbs::MANUAL_BREADCRUMB_TYPE,
:metaData => {
:a => 1
@@ -311,7 +311,7 @@ module Kernel
Bugsnag.leave_breadcrumb("TestName")
expect(breadcrumbs.to_a.size).to eq(1)
expect(breadcrumbs.first.to_h).to match({
- :name => "123123123123123123123123123123",
+ :name => "123123123123123123123123123123456456456456456",
:type => Bugsnag::Breadcrumbs::MANUAL_BREADCRUMB_TYPE,
:metaData => {
:int => 1
diff --git a/spec/cleaner_spec.rb b/spec/cleaner_spec.rb
index b40c657f2..96bb9dfec 100644
--- a/spec/cleaner_spec.rb
+++ b/spec/cleaner_spec.rb
@@ -3,7 +3,7 @@
require 'spec_helper'
describe Bugsnag::Cleaner do
- subject { described_class.new(nil) }
+ subject { Bugsnag::Cleaner.new(Bugsnag::Configuration.new) }
describe "#clean_object" do
is_jruby = defined?(RUBY_ENGINE) && RUBY_ENGINE == 'jruby'
@@ -134,6 +134,17 @@ def to_s
expect(subject.clean_object(object)).to eq("[RECURSION]")
end
+ it "cleans custom objects to show the id of the object if object responds to id method" do
+ class MacaronWithId
+ def id
+ 10
+ end
+ end
+
+ a = MacaronWithId.new
+ expect(subject.clean_object(a)).to eq("[OBJECT]: [Class]: #{a.class.name} [ID]: #{a.id}")
+ end
+
it "cleans up binary strings properly" do
if RUBY_VERSION > "1.9"
obj = "Andr\xc7\xff"
@@ -156,23 +167,113 @@ def to_s
end
it "filters by string inclusion" do
- expect(described_class.new(['f']).clean_object({ :foo => 'bar' })).to eq({ :foo => '[FILTERED]' })
- expect(described_class.new(['b']).clean_object({ :foo => 'bar' })).to eq({ :foo => 'bar' })
+ object = { events: { metaData: { foo: 'bar' } } }
+
+ configuration = Bugsnag::Configuration.new
+ configuration.meta_data_filters = ['f']
+
+ cleaner = Bugsnag::Cleaner.new(configuration)
+ expect(cleaner.clean_object(object)).to eq({ events: { metaData: { foo: '[FILTERED]' } } })
+
+ configuration = Bugsnag::Configuration.new
+ configuration.meta_data_filters = ['b']
+
+ cleaner = Bugsnag::Cleaner.new(configuration)
+ expect(cleaner.clean_object(object)).to eq({ events: { metaData: { foo: 'bar' } } })
end
it "filters by regular expression" do
- expect(described_class.new([/fb?/]).clean_object({ :foo => 'bar' })).to eq({ :foo => '[FILTERED]' })
- expect(described_class.new([/fb+/]).clean_object({ :foo => 'bar' })).to eq({ :foo => 'bar' })
+ object = { events: { metaData: { foo: 'bar' } } }
+
+ configuration = Bugsnag::Configuration.new
+ configuration.meta_data_filters = [/fb?/]
+
+ cleaner = Bugsnag::Cleaner.new(configuration)
+ expect(cleaner.clean_object(object)).to eq({ events: { metaData: { foo: '[FILTERED]' } } })
+
+ configuration = Bugsnag::Configuration.new
+ configuration.meta_data_filters = [/fb+/]
+
+ cleaner = Bugsnag::Cleaner.new(configuration)
+ expect(cleaner.clean_object(object)).to eq({ events: { metaData: { foo: 'bar' } } })
end
it "filters deeply nested keys" do
- params = {:foo => {:bar => "baz"}}
- expect(described_class.new([/^foo\.bar/]).clean_object(params)).to eq({:foo => {:bar => '[FILTERED]'}})
+ configuration = Bugsnag::Configuration.new
+ configuration.meta_data_filters = [/^foo\.bar/]
+
+ cleaner = Bugsnag::Cleaner.new(configuration)
+
+ params = { events: { metaData: { foo: { bar: 'baz' } } } }
+ expect(cleaner.clean_object(params)).to eq({ events: { metaData: { foo: { bar: '[FILTERED]' } } } })
end
it "filters deeply nested request parameters" do
- params = {:request => {:params => {:foo => {:bar => "baz"}}}}
- expect(described_class.new([/^foo\.bar/]).clean_object(params)).to eq({:request => {:params => {:foo => {:bar => '[FILTERED]'}}}})
+ configuration = Bugsnag::Configuration.new
+ configuration.meta_data_filters = [/^foo\.bar/]
+
+ cleaner = Bugsnag::Cleaner.new(configuration)
+
+ params = { events: { metaData: { request: { params: { foo: { bar: 'baz' } } } } } }
+ expect(cleaner.clean_object(params)).to eq({ events: { metaData: { request: { params: { foo: { bar: '[FILTERED]' } } } } } })
+ end
+
+ it "doesn't filter by string inclusion when the scope is not in 'scopes_to_filter'" do
+ object = { foo: 'bar' }
+
+ configuration = Bugsnag::Configuration.new
+ configuration.meta_data_filters = ['f']
+
+ cleaner = Bugsnag::Cleaner.new(configuration)
+
+ expect(cleaner.clean_object(object)).to eq({ foo: 'bar' })
+
+ configuration = Bugsnag::Configuration.new
+ configuration.meta_data_filters = ['b']
+
+ cleaner = Bugsnag::Cleaner.new(configuration)
+
+ expect(cleaner.clean_object(object)).to eq({ foo: 'bar' })
+ end
+
+ it "doesn't filter by regular expression when the scope is not in 'scopes_to_filter'" do
+ object = { foo: 'bar' }
+
+ configuration = Bugsnag::Configuration.new
+ configuration.meta_data_filters = [/fb?/]
+
+ cleaner = Bugsnag::Cleaner.new(configuration)
+
+ expect(cleaner.clean_object(object)).to eq({ foo: 'bar' })
+
+ configuration = Bugsnag::Configuration.new
+ configuration.meta_data_filters = [/fb+/]
+
+ cleaner = Bugsnag::Cleaner.new(configuration)
+
+ expect(cleaner.clean_object(object)).to eq({ foo: 'bar' })
+ end
+
+ it "doesn't filter deeply nested keys when the scope is not in 'scopes_to_filter'" do
+ params = { foo: { bar: 'baz' } }
+
+ configuration = Bugsnag::Configuration.new
+ configuration.meta_data_filters = [/^foo\.bar/]
+
+ cleaner = Bugsnag::Cleaner.new(configuration)
+
+ expect(cleaner.clean_object(params)).to eq({ foo: { bar: 'baz' } })
+ end
+
+ it "doesn't filter deeply nested request parameters when the scope is not in 'scopes_to_filter'" do
+ params = { request: { params: { foo: { bar: 'baz' } } } }
+
+ configuration = Bugsnag::Configuration.new
+ configuration.meta_data_filters = [/^foo\.bar/]
+
+ cleaner = Bugsnag::Cleaner.new(configuration)
+
+ expect(cleaner.clean_object(params)).to eq({ request: { params: { foo: { bar: 'baz' } } } })
end
it "filters objects which can't be stringified" do
@@ -187,7 +288,12 @@ def to_s
describe "#clean_url" do
let(:filters) { [] }
- subject { described_class.new(filters).clean_url(url) }
+
+ subject do
+ configuration = Bugsnag::Configuration.new
+ configuration.meta_data_filters = filters
+ described_class.new(configuration).clean_url(url)
+ end
context "with no filters configured" do
let(:url) { "/dir/page?param1=value1¶m2=value2" }
diff --git a/spec/configuration_spec.rb b/spec/configuration_spec.rb
index 5db5e5f23..9bc1d5345 100644
--- a/spec/configuration_spec.rb
+++ b/spec/configuration_spec.rb
@@ -332,10 +332,14 @@ def debug(name, &block)
end
end
- it "should have exit exception classes ignored by default" do
+ it "should have exit exception classes in ignore_classes by default" do
expect(subject.ignore_classes).to eq(Set.new([SystemExit, SignalException]))
end
+ it "should have nothing in discard_classes by default" do
+ expect(subject.discard_classes).to eq(Set.new([]))
+ end
+
describe "#breadcrumbs" do
it "first returns a new circular buffer" do
buffer = subject.breadcrumbs
diff --git a/spec/helper_spec.rb b/spec/helper_spec.rb
index 57089afbe..11323c932 100644
--- a/spec/helper_spec.rb
+++ b/spec/helper_spec.rb
@@ -4,23 +4,7 @@
require 'set'
describe Bugsnag::Helpers do
-
describe "trim_if_needed" do
-
- it "breaks recursion" do
- a = [1, 2, 3]
- b = [2, a]
- a << b
- value = Bugsnag::Helpers.trim_if_needed(a)
- expect(value).to eq([1, 2, 3, [2, "[RECURSION]"]])
- end
-
- it "does not break equal objects without recursion" do
- data = [1, [1, 2], [1, 2], "a"]
- value = Bugsnag::Helpers.trim_if_needed(data)
- expect(value).to eq data
- end
-
it "preserves bool types" do
value = Bugsnag::Helpers.trim_if_needed([1, 3, true, "NO", "2", false])
expect(value[2]).to be_a(TrueClass)
@@ -39,76 +23,7 @@
expect(value[4]).to be_a(String)
end
- context "an object will throw if `to_s` is called" do
- class StringRaiser
- def to_s
- raise 'Oh no you do not!'
- end
- end
-
- it "uses the string '[RAISED]' instead" do
- value = Bugsnag::Helpers.trim_if_needed([1, 3, StringRaiser.new])
- expect(value[2]).to eq "[RAISED]"
- end
-
- it "replaces hash key with '[RAISED]'" do
- a = {}
- a[StringRaiser.new] = 1
-
- value = Bugsnag::Helpers.trim_if_needed(a)
- expect(value).to eq({ "[RAISED]" => "[FILTERED]" })
- end
-
- it "uses a single '[RAISED]'key when multiple keys raise" do
- a = {}
- a[StringRaiser.new] = 1
- a[StringRaiser.new] = 2
-
- value = Bugsnag::Helpers.trim_if_needed(a)
- expect(value).to eq({ "[RAISED]" => "[FILTERED]" })
- end
- end
-
- context "an object will infinitely recurse if `to_s` is called" do
- is_jruby = defined?(RUBY_ENGINE) && RUBY_ENGINE == 'jruby'
-
- class StringRecurser
- def to_s
- to_s
- end
- end
-
- it "uses the string '[RECURSION]' instead" do
- skip "JRuby doesn't allow recovery from SystemStackErrors" if is_jruby
-
- value = Bugsnag::Helpers.trim_if_needed([1, 3, StringRecurser.new])
- expect(value[2]).to eq "[RECURSION]"
- end
-
- it "replaces hash key with '[RECURSION]'" do
- skip "JRuby doesn't allow recovery from SystemStackErrors" if is_jruby
-
- a = {}
- a[StringRecurser.new] = 1
-
- value = Bugsnag::Helpers.trim_if_needed(a)
- expect(value).to eq({ "[RECURSION]" => "[FILTERED]" })
- end
-
- it "uses a single '[RECURSION]'key when multiple keys recurse" do
- skip "JRuby doesn't allow recovery from SystemStackErrors" if is_jruby
-
- a = {}
- a[StringRecurser.new] = 1
- a[StringRecurser.new] = 2
-
- value = Bugsnag::Helpers.trim_if_needed(a)
- expect(value).to eq({ "[RECURSION]" => "[FILTERED]" })
- end
- end
-
context "payload length is less than allowed" do
-
it "does not change strings" do
value = SecureRandom.hex(4096)
expect(Bugsnag::Helpers.trim_if_needed(value)).to eq value
@@ -126,7 +41,6 @@ def to_s
end
context "payload length is greater than allowed" do
-
it "trims metadata strings" do
payload = {
:events => [{
diff --git a/spec/integrations/rack_spec.rb b/spec/integrations/rack_spec.rb
index 95cc9f013..57847efa4 100644
--- a/spec/integrations/rack_spec.rb
+++ b/spec/integrations/rack_spec.rb
@@ -127,9 +127,10 @@ class Request
expect(report).to receive(:context=).with("TEST /TEST_PATH")
expect(report).to receive(:user).and_return({})
- config = double
- allow(config).to receive(:send_environment).and_return(true)
- allow(config).to receive(:meta_data_filters).and_return(['email'])
+ config = Bugsnag.configuration
+ config.send_environment = true
+ config.meta_data_filters = ['email']
+
allow(report).to receive(:configuration).and_return(config)
expect(report).to receive(:add_tab).once.with(:request, {
:url => "http://test_host/TEST_PATH?email=[FILTERED]&another_param=thing",
@@ -187,9 +188,10 @@ class Request
expect(report).to receive(:context=).with("TEST /TEST_PATH")
expect(report).to receive(:user).and_return({})
- config = double
- allow(config).to receive(:send_environment).and_return(true)
- allow(config).to receive(:meta_data_filters).and_return(nil)
+ config = Bugsnag.configuration
+ config.send_environment = true
+ config.meta_data_filters = []
+
allow(report).to receive(:configuration).and_return(config)
expect(report).to receive(:add_tab).once.with(:environment, rack_env)
expect(report).to receive(:add_tab).once.with(:request, {
diff --git a/spec/report_spec.rb b/spec/report_spec.rb
index 3d4b8530f..91126274d 100644
--- a/spec/report_spec.rb
+++ b/spec/report_spec.rb
@@ -1,5 +1,5 @@
# encoding: utf-8
-require 'spec_helper'
+require_relative './spec_helper'
require 'securerandom'
require 'ostruct'
@@ -27,6 +27,7 @@ def gloops
end
end
+# rubocop:disable Metrics/BlockLength
describe Bugsnag::Report do
it "should contain an api_key if one is set" do
Bugsnag.notify(BugsnagTestException.new("It crashed"))
@@ -149,10 +150,12 @@ def gloops
original_ignore_classes = Bugsnag.configuration.ignore_classes
begin
- # The default ignore_classes includes SignalException, so we need to
+ # The default ignore classes includes SignalException, so we need to
# temporarily set it to something else.
Bugsnag.configuration.ignore_classes = Set[SystemExit]
+
Bugsnag.notify(SignalException.new("TERM"))
+
expect(Bugsnag).to have_sent_notification{ |payload, headers|
event = get_event_from_payload(payload)
expect(event["unhandled"]).to be false
@@ -589,7 +592,6 @@ def gloops
end
it "filters params from all payload hashes if they are set in default meta_data_filters" do
-
Bugsnag.notify(BugsnagTestException.new("It crashed")) do |report|
report.meta_data.merge!({
:request => {
@@ -635,7 +637,6 @@ def gloops
end
it "filters params from all payload hashes if they are added to meta_data_filters" do
-
Bugsnag.configuration.meta_data_filters << "other_data"
Bugsnag.notify(BugsnagTestException.new("It crashed")) do |report|
report.meta_data.merge!({:request => {:params => {:password => "1234", :other_password => "123456", :other_data => "123456"}}})
@@ -653,7 +654,6 @@ def gloops
end
it "filters params from all payload hashes if they are added to meta_data_filters as regex" do
-
Bugsnag.configuration.meta_data_filters << /other_data/
Bugsnag.notify(BugsnagTestException.new("It crashed")) do |report|
report.meta_data.merge!({:request => {:params => {:password => "1234", :other_password => "123456", :other_data => "123456"}}})
@@ -671,7 +671,6 @@ def gloops
end
it "filters params from all payload hashes if they are added to meta_data_filters as partial regex" do
-
Bugsnag.configuration.meta_data_filters << /r_data/
Bugsnag.notify(BugsnagTestException.new("It crashed")) do |report|
report.meta_data.merge!({:request => {:params => {:password => "1234", :other_password => "123456", :other_data => "123456"}}})
@@ -702,6 +701,33 @@ def gloops
}
end
+ it "does not apply filters outside of report.meta_data" do
+ Bugsnag.configuration.meta_data_filters << "data"
+
+ Bugsnag.notify(BugsnagTestException.new("It crashed")) do |report|
+ report.meta_data = {
+ xyz: "abc",
+ data: "123456"
+ }
+
+ report.user = {
+ id: 123,
+ data: "hello"
+ }
+ end
+
+ expect(Bugsnag).to have_sent_notification{ |payload, headers|
+ event = get_event_from_payload(payload)
+
+ expect(event["metaData"]).not_to be_nil
+ expect(event["metaData"]["xyz"]).to eq("abc")
+ expect(event["metaData"]["data"]).to eq("[FILTERED]")
+
+ expect(event["user"]).not_to be_nil
+ expect(event["user"]["data"]).to eq("hello")
+ }
+ end
+
it "does not notify if report ignored" do
Bugsnag.notify(BugsnagTestException.new("It crashed")) do |report|
report.ignore!
@@ -710,38 +736,154 @@ def gloops
expect(Bugsnag).not_to have_sent_notification
end
- it "does not notify if the exception class is in the default ignore_classes list" do
- Bugsnag.configuration.ignore_classes << ActiveRecord::RecordNotFound
- Bugsnag.notify(ActiveRecord::RecordNotFound.new("It crashed"))
+ context "ignore_classes" do
+ context "as a constant" do
+ it "ignores exception when its class is ignored" do
+ Bugsnag.configuration.ignore_classes << BugsnagTestException
- expect(Bugsnag).not_to have_sent_notification
- end
+ Bugsnag.notify(BugsnagTestException.new("It crashed"))
- it "does not notify if the non-default exception class is added to the ignore_classes" do
- Bugsnag.configuration.ignore_classes << BugsnagTestException
+ expect(Bugsnag).not_to have_sent_notification
+ end
- Bugsnag.notify(BugsnagTestException.new("It crashed"))
+ it "ignores exception when its ancestor is ignored" do
+ Bugsnag.configuration.ignore_classes << BugsnagTestException
- expect(Bugsnag).not_to have_sent_notification
- end
+ Bugsnag.notify(BugsnagSubclassTestException.new("It crashed"))
- it "does not notify if exception's ancestor is an ignored class" do
- Bugsnag.configuration.ignore_classes << BugsnagTestException
+ expect(Bugsnag).not_to have_sent_notification
+ end
- Bugsnag.notify(BugsnagSubclassTestException.new("It crashed"))
+ it "ignores exception when the original exception is ignored" do
+ Bugsnag.configuration.ignore_classes << BugsnagTestException
- expect(Bugsnag).not_to have_sent_notification
+ ex = NestedException.new("Self-referential exception")
+ ex.original_exception = BugsnagTestException.new("It crashed")
+
+ Bugsnag.notify(ex)
+
+ expect(Bugsnag).not_to have_sent_notification
+ end
+ end
+
+ context "as a proc" do
+ it "ignores exception when the proc returns true" do
+ Bugsnag.configuration.ignore_classes << ->(exception) { true }
+
+ Bugsnag.notify(BugsnagTestException.new("It crashed"))
+
+ expect(Bugsnag).not_to have_sent_notification
+ end
+
+ it "does not ignore exception when proc returns false" do
+ Bugsnag.configuration.ignore_classes << ->(exception) { false }
+
+ Bugsnag.notify(BugsnagTestException.new("It crashed"))
+
+ expect(Bugsnag).to have_sent_notification { |payload, headers|
+ exception = get_exception_from_payload(payload)
+
+ expect(exception["errorClass"]).to eq("BugsnagTestException")
+ expect(exception["message"]).to eq("It crashed")
+ }
+ end
+ end
end
- it "does not notify if any caused exception is an ignored class" do
- Bugsnag.configuration.ignore_classes << NestedException
+ context "discard_classes" do
+ context "as a string" do
+ it "discards exception when its class should be discarded" do
+ Bugsnag.configuration.discard_classes << "BugsnagTestException"
- ex = NestedException.new("Self-referential exception")
- ex.original_exception = BugsnagTestException.new("It crashed")
+ Bugsnag.notify(BugsnagTestException.new("It crashed"))
- Bugsnag.notify(ex)
+ expect(Bugsnag).not_to have_sent_notification
+ end
- expect(Bugsnag).not_to have_sent_notification
+ it "discards exception when the original exception should be discarded" do
+ Bugsnag.configuration.discard_classes << "BugsnagTestException"
+
+ ex = NestedException.new("Self-referential exception")
+ ex.original_exception = BugsnagTestException.new("It crashed")
+
+ Bugsnag.notify(ex)
+
+ expect(Bugsnag).not_to have_sent_notification
+ end
+
+ it "does not discard exception with a typo" do
+ Bugsnag.configuration.discard_classes << "BugsnagToastException"
+
+ Bugsnag.notify(BugsnagTestException.new("It crashed"))
+
+ expect(Bugsnag).to have_sent_notification { |payload, headers|
+ exception = get_exception_from_payload(payload)
+
+ expect(exception["errorClass"]).to eq("BugsnagTestException")
+ expect(exception["message"]).to eq("It crashed")
+ }
+ end
+
+ it "does not discard exception when its ancestor is discarded" do
+ Bugsnag.configuration.discard_classes << "BugsnagTestException"
+
+ Bugsnag.notify(BugsnagSubclassTestException.new("It crashed"))
+
+ expect(Bugsnag).to have_sent_notification { |payload, headers|
+ exception = get_exception_from_payload(payload)
+
+ expect(exception["errorClass"]).to eq("BugsnagSubclassTestException")
+ expect(exception["message"]).to eq("It crashed")
+ }
+ end
+ end
+
+ context "as a regexp" do
+ it "discards exception when its class should be discarded" do
+ Bugsnag.configuration.discard_classes << /^BugsnagTest.*/
+
+ Bugsnag.notify(BugsnagTestException.new("It crashed"))
+
+ expect(Bugsnag).not_to have_sent_notification
+ end
+
+ it "discards exception when the original exception should be discarded" do
+ Bugsnag.configuration.discard_classes << /^BugsnagTest.*/
+
+ ex = NestedException.new("Self-referential exception")
+ ex.original_exception = BugsnagTestException.new("It crashed")
+
+ Bugsnag.notify(ex)
+
+ expect(Bugsnag).not_to have_sent_notification
+ end
+
+ it "does not discard exception when regexp does not match" do
+ Bugsnag.configuration.discard_classes << /^NotBugsnag.*/
+
+ Bugsnag.notify(BugsnagTestException.new("It crashed"))
+
+ expect(Bugsnag).to have_sent_notification { |payload, headers|
+ exception = get_exception_from_payload(payload)
+
+ expect(exception["errorClass"]).to eq("BugsnagTestException")
+ expect(exception["message"]).to eq("It crashed")
+ }
+ end
+
+ it "does not discard exception when its ancestor is discarded" do
+ Bugsnag.configuration.discard_classes << /^BugsnagTest.*/
+
+ Bugsnag.notify(BugsnagSubclassTestException.new("It crashed"))
+
+ expect(Bugsnag).to have_sent_notification { |payload, headers|
+ exception = get_exception_from_payload(payload)
+
+ expect(exception["errorClass"]).to eq("BugsnagSubclassTestException")
+ expect(exception["message"]).to eq("It crashed")
+ }
+ end
+ end
end
it "sends the cause of the exception" do
@@ -989,6 +1131,161 @@ def gloops
}
end
+ it "should handle recursive metadata" do
+ a = [1, 2, 3]
+ b = [2, a]
+ a << b
+ c = [1, 2, 3]
+
+ Bugsnag.notify(BugsnagTestException.new("It crashed")) do |report|
+ report.add_tab(:some_tab, {
+ a: a,
+ b: b,
+ c: c
+ })
+ end
+
+ expect(Bugsnag).to have_sent_notification{ |payload, headers|
+ event = get_event_from_payload(payload)
+ expect(event["metaData"]["some_tab"]).to eq({
+ "a" => [1, 2, 3, [2, "[RECURSION]"]],
+ "b" => [2, "[RECURSION]"],
+ "c" => [1, 2, 3]
+ })
+ }
+ end
+
+ it "does not detect two equal objects as recursion" do
+ Bugsnag.notify(BugsnagTestException.new("It crashed")) do |report|
+ report.add_tab(:some_tab, {
+ data: [1, [1, 2], [1, 2], "a"]
+ })
+ end
+
+ expect(Bugsnag).to have_sent_notification{ |payload, headers|
+ event = get_event_from_payload(payload)
+ expect(event["metaData"]["some_tab"]).to eq({
+ "data" => [1, [1, 2], [1, 2], "a"]
+ })
+ }
+ end
+
+ context "an object that throws if `to_s` is called" do
+ class StringRaiser
+ def to_s
+ raise 'Oh no you do not!'
+ end
+ end
+
+ it "uses the string '[RAISED]' instead" do
+ Bugsnag.notify(BugsnagTestException.new("It crashed")) do |report|
+ report.add_tab(:some_tab, {
+ data: [1, 2, StringRaiser.new]
+ })
+ end
+
+ expect(Bugsnag).to have_sent_notification{ |payload, headers|
+ event = get_event_from_payload(payload)
+ expect(event["metaData"]["some_tab"]).to eq({
+ "data" => [1, 2, "[RAISED]"]
+ })
+ }
+ end
+
+ it "replaces hash key with '[RAISED]'" do
+ Bugsnag.notify(BugsnagTestException.new("It crashed")) do |report|
+ report.add_tab(:some_tab, {
+ StringRaiser.new => 1
+ })
+ end
+
+ expect(Bugsnag).to have_sent_notification{ |payload, headers|
+ event = get_event_from_payload(payload)
+ expect(event["metaData"]["some_tab"]).to eq({
+ "[RAISED]" => "[FILTERED]"
+ })
+ }
+ end
+
+ it "uses a single '[RAISED]'key when multiple keys raise" do
+ Bugsnag.notify(BugsnagTestException.new("It crashed")) do |report|
+ report.add_tab(:some_tab, {
+ StringRaiser.new => 1,
+ StringRaiser.new => 2
+ })
+ end
+
+ expect(Bugsnag).to have_sent_notification{ |payload, headers|
+ event = get_event_from_payload(payload)
+ expect(event["metaData"]["some_tab"]).to eq({
+ "[RAISED]" => "[FILTERED]"
+ })
+ }
+ end
+ end
+
+ context "an object that infinitely recurse if `to_s` is called" do
+ is_jruby = defined?(RUBY_ENGINE) && RUBY_ENGINE == 'jruby'
+
+ class StringRecurser
+ def to_s
+ to_s
+ end
+ end
+
+ it "uses the string '[RECURSION]' instead" do
+ skip "JRuby doesn't allow recovery from SystemStackErrors" if is_jruby
+
+ Bugsnag.notify(BugsnagTestException.new("It crashed")) do |report|
+ report.add_tab(:some_tab, {
+ data: [1, 2, StringRecurser.new]
+ })
+ end
+
+ expect(Bugsnag).to have_sent_notification{ |payload, headers|
+ event = get_event_from_payload(payload)
+ expect(event["metaData"]["some_tab"]).to eq({
+ "data" => [1, 2, "[RECURSION]"]
+ })
+ }
+ end
+
+ it "replaces hash key with '[RECURSION]'" do
+ skip "JRuby doesn't allow recovery from SystemStackErrors" if is_jruby
+
+ Bugsnag.notify(BugsnagTestException.new("It crashed")) do |report|
+ report.add_tab(:some_tab, {
+ StringRecurser.new => 1
+ })
+ end
+
+ expect(Bugsnag).to have_sent_notification{ |payload, headers|
+ event = get_event_from_payload(payload)
+ expect(event["metaData"]["some_tab"]).to eq({
+ "[RECURSION]" => "[FILTERED]"
+ })
+ }
+ end
+
+ it "uses a single '[RECURSION]'key when multiple keys recurse" do
+ skip "JRuby doesn't allow recovery from SystemStackErrors" if is_jruby
+
+ Bugsnag.notify(BugsnagTestException.new("It crashed")) do |report|
+ report.add_tab(:some_tab, {
+ StringRecurser.new => 1,
+ StringRecurser.new => 2
+ })
+ end
+
+ expect(Bugsnag).to have_sent_notification{ |payload, headers|
+ event = get_event_from_payload(payload)
+ expect(event["metaData"]["some_tab"]).to eq({
+ "[RECURSION]" => "[FILTERED]"
+ })
+ }
+ end
+ end
+
it 'should handle exceptions with empty backtrace' do
begin
err = RuntimeError.new
@@ -1280,3 +1577,4 @@ def gloops
}
end
end
+# rubocop:enable Metrics/BlockLength
diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb
index 6584fd1ea..b172d183b 100644
--- a/spec/spec_helper.rb
+++ b/spec/spec_helper.rb
@@ -10,6 +10,7 @@
require 'bugsnag'
+require 'tmpdir'
require 'webmock/rspec'
require 'rspec/expectations'
require 'rspec/mocks'
@@ -43,12 +44,16 @@ def ruby_version_greater_equal?(version)
RSpec.configure do |config|
config.order = "random"
+ config.example_status_persistence_file_path = "#{Dir.tmpdir}/rspec_status"
config.before(:each) do
WebMock.stub_request(:post, "https://notify.bugsnag.com/")
WebMock.stub_request(:post, "https://sessions.bugsnag.com/")
Bugsnag.instance_variable_set(:@configuration, Bugsnag::Configuration.new)
+ Bugsnag.instance_variable_set(:@session_tracker, Bugsnag::SessionTracker.new)
+ Bugsnag.instance_variable_set(:@cleaner, Bugsnag::Cleaner.new(Bugsnag.configuration))
+
Bugsnag.configure do |bugsnag|
bugsnag.api_key = "c9d60ae4c7e70c4b6c4ebd3e8056d2b8"
bugsnag.release_stage = "production"
@@ -83,4 +88,4 @@ def have_sent_notification(&matcher)
raise "no matcher provided to have_sent_notification (did you use { })"
end
end
-end
\ No newline at end of file
+end
diff --git a/spec/stacktrace_spec.rb b/spec/stacktrace_spec.rb
index f17b2dff3..909d4e025 100644
--- a/spec/stacktrace_spec.rb
+++ b/spec/stacktrace_spec.rb
@@ -1,91 +1,159 @@
require 'spec_helper'
describe Bugsnag::Stacktrace do
- it "includes code in the stack trace" do
- begin
- _a = 1
- _b = 2
- _c = 3
- "Test".prepnd "T"
- _d = 4
- _e = 5
- _f = 6
- rescue Exception => e
- Bugsnag.notify(e)
+ context "sending code" do
+ it "includes code in the stack trace" do
+ begin
+ _a = 1
+ _b = 2
+ _c = 3
+ "Test".prepnd "T"
+ _d = 4
+ _e = 5
+ _f = 6
+ rescue Exception => e
+ Bugsnag.notify(e)
+ end
+
+ expect(Bugsnag).to have_sent_notification{ |payload, headers|
+ exception = get_exception_from_payload(payload)
+ starting_line = __LINE__ - 13
+ expect(exception["stacktrace"][0]["code"]).to eq({
+ (starting_line + 0).to_s => ' _a = 1',
+ (starting_line + 1).to_s => ' _b = 2',
+ (starting_line + 2).to_s => ' _c = 3',
+ (starting_line + 3).to_s => ' "Test".prepnd "T"',
+ (starting_line + 4).to_s => ' _d = 4',
+ (starting_line + 5).to_s => ' _e = 5',
+ (starting_line + 6).to_s => ' _f = 6'
+ })
+ }
end
- expect(Bugsnag).to have_sent_notification{ |payload, headers|
- exception = get_exception_from_payload(payload)
- starting_line = __LINE__ - 13
- expect(exception["stacktrace"][0]["code"]).to eq({
- (starting_line + 0).to_s => ' _a = 1',
- (starting_line + 1).to_s => ' _b = 2',
- (starting_line + 2).to_s => ' _c = 3',
- (starting_line + 3).to_s => ' "Test".prepnd "T"',
- (starting_line + 4).to_s => ' _d = 4',
- (starting_line + 5).to_s => ' _e = 5',
- (starting_line + 6).to_s => ' _f = 6'
+ it "allows you to disable sending code" do
+ Bugsnag.configuration.send_code = false
+
+ notify_test_exception
+
+ expect(Bugsnag).to have_sent_notification{ |payload, headers|
+ exception = get_exception_from_payload(payload)
+ expect(exception["stacktrace"][1]["code"]).to eq(nil)
+ }
+ end
+
+ it 'should send the first 7 lines of the file for exceptions near the top' do
+ load 'spec/fixtures/crashes/start_of_file.rb' rescue Bugsnag.notify $!
+
+ expect(Bugsnag).to have_sent_notification{ |payload, headers|
+ exception = get_exception_from_payload(payload)
+
+ expect(exception["stacktrace"][0]["code"]).to eq({
+ "1" => "#",
+ "2" => "raise 'hell'",
+ "3" => "#",
+ "4" => "#",
+ "5" => "#",
+ "6" => "#",
+ "7" => "#"
})
- }
- end
+ }
+ end
- it "allows you to disable sending code" do
- Bugsnag.configuration.send_code = false
+ it 'should send the last 7 lines of the file for exceptions near the bottom' do
+ load 'spec/fixtures/crashes/end_of_file.rb' rescue Bugsnag.notify $!
- notify_test_exception
+ expect(Bugsnag).to have_sent_notification{ |payload, headers|
+ exception = get_exception_from_payload(payload)
- expect(Bugsnag).to have_sent_notification{ |payload, headers|
- exception = get_exception_from_payload(payload)
- expect(exception["stacktrace"][1]["code"]).to eq(nil)
- }
- end
+ expect(exception["stacktrace"][0]["code"]).to eq({
+ "3" => "#",
+ "4" => "#",
+ "5" => "#",
+ "6" => "#",
+ "7" => "#",
+ "8" => "raise 'hell'",
+ "9" => "#"
+ })
+ }
+ end
- it 'should send the first 7 lines of the file for exceptions near the top' do
- load 'spec/fixtures/crashes/start_of_file.rb' rescue Bugsnag.notify $!
-
- expect(Bugsnag).to have_sent_notification{ |payload, headers|
- exception = get_exception_from_payload(payload)
-
- expect(exception["stacktrace"][0]["code"]).to eq({
- "1" => "#",
- "2" => "raise 'hell'",
- "3" => "#",
- "4" => "#",
- "5" => "#",
- "6" => "#",
- "7" => "#"
- })
- }
- end
+ it 'should send the last 7 lines of the file for exceptions near the bottom' do
+ load 'spec/fixtures/crashes/short_file.rb' rescue Bugsnag.notify $!
+
+ expect(Bugsnag).to have_sent_notification{ |payload, headers|
+ exception = get_exception_from_payload(payload)
- it 'should send the last 7 lines of the file for exceptions near the bottom' do
- load 'spec/fixtures/crashes/end_of_file.rb' rescue Bugsnag.notify $!
-
- expect(Bugsnag).to have_sent_notification{ |payload, headers|
- exception = get_exception_from_payload(payload)
-
- expect(exception["stacktrace"][0]["code"]).to eq({
- "3" => "#",
- "4" => "#",
- "5" => "#",
- "6" => "#",
- "7" => "#",
- "8" => "raise 'hell'",
- "9" => "#"
- })
- }
+ expect(exception["stacktrace"][0]["code"]).to eq({
+ "1" => "raise 'hell'"
+ })
+ }
+ end
end
- it 'should send the last 7 lines of the file for exceptions near the bottom' do
- load 'spec/fixtures/crashes/short_file.rb' rescue Bugsnag.notify $!
+ context "file paths" do
+ it "leaves absolute paths alone" do
+ configuration = Bugsnag::Configuration.new
+ configuration.send_code = false
+
+ backtrace = [
+ "/foo/bar/app/models/user.rb:1:in `something'",
+ "/foo/bar/other_vendor/lib/dont.rb:2:in `to_s'",
+ "/foo/bar/vendor/lib/ignore_me.rb:3:in `to_s'",
+ "/foo/bar/.bundle/lib/ignore_me.rb:4:in `to_s'",
+ ]
+
+ stacktrace = Bugsnag::Stacktrace.new(backtrace, configuration).to_a
+
+ expect(stacktrace).to eq([
+ { file: "/foo/bar/app/models/user.rb", lineNumber: 1, method: "something" },
+ { file: "/foo/bar/other_vendor/lib/dont.rb", lineNumber: 2, method: "to_s" },
+ { file: "/foo/bar/vendor/lib/ignore_me.rb", lineNumber: 3, method: "to_s" },
+ { file: "/foo/bar/.bundle/lib/ignore_me.rb", lineNumber: 4, method: "to_s" },
+ ])
+ end
+
+ it "does not modify relative paths if they can't be resolved" do
+ configuration = Bugsnag::Configuration.new
+
+ backtrace = [
+ "./foo/bar/baz.rb:1:in `something'",
+ "../foo.rb:1:in `to_s'",
+ "../xyz.rb:1:in `to_s'",
+ "abc.rb:1:in `defg'",
+ ]
- expect(Bugsnag).to have_sent_notification{ |payload, headers|
- exception = get_exception_from_payload(payload)
+ stacktrace = Bugsnag::Stacktrace.new(backtrace, configuration).to_a
- expect(exception["stacktrace"][0]["code"]).to eq({
- "1" => "raise 'hell'"
- })
- }
+ expect(stacktrace).to eq([
+ { code: nil, file: "./foo/bar/baz.rb", lineNumber: 1, method: "something" },
+ { code: nil, file: "../foo.rb", lineNumber: 1, method: "to_s" },
+ { code: nil, file: "../xyz.rb", lineNumber: 1, method: "to_s" },
+ { code: nil, file: "abc.rb", lineNumber: 1, method: "defg" },
+ ])
+ end
+
+ it "resolves relative paths when the files exist" do
+ configuration = Bugsnag::Configuration.new
+ configuration.send_code = false
+
+ dir = File.dirname(__FILE__)
+
+ backtrace = [
+ "./spec/spec_helper.rb:1:in `something'",
+ "./lib/bugsnag/breadcrumbs/../configuration.rb:100:in `to_s'",
+ "lib/bugsnag.rb:20:in `notify'",
+ "#{dir}/../spec/stacktrace_spec.rb:5:in `something_else'",
+ ]
+
+ stacktrace = Bugsnag::Stacktrace.new(backtrace, configuration).to_a
+
+ expect(stacktrace).to eq([
+ { file: "#{dir}/spec_helper.rb", lineNumber: 1, method: "something" },
+ { file: "#{File.dirname(dir)}/lib/bugsnag/configuration.rb", lineNumber: 100, method: "to_s" },
+ { file: "#{File.dirname(dir)}/lib/bugsnag.rb", lineNumber: 20, method: "notify" },
+ { file: "#{dir}/stacktrace_spec.rb", lineNumber: 5, method: "something_else" },
+ ])
+ end
end
context "with configurable vendor_path" do