Merge remote-tracking branch 'origin/next' into ruby-waring

Author: tomlongridge

.rubocop_todo.yml

@@ -289,6 +289,9 @@ Metrics/BlockNesting:
 # Configuration parameters: CountComments.
 Metrics/ClassLength:
   Max: 149
+  Exclude:
+    - 'lib/bugsnag/report.rb'
+    - 'lib/bugsnag/configuration.rb'
 
 # Offense count: 12
 Metrics/CyclomaticComplexity:
@@ -305,6 +308,7 @@ Metrics/ModuleLength:
   Max: 125
   Exclude:
     - 'lib/bugsnag/helpers.rb'
+    - 'lib/bugsnag.rb'
 
 # Offense count: 11
 Metrics/PerceivedComplexity:

CHANGELOG.md

@@ -1,6 +1,65 @@
 Changelog
 =========
 
+## TBC
+
+### Fixes
+
+* Account for missing `:binds` key in `sql.active_record` ActiveSupport notifications
+  | [#555](https://github.com/bugsnag/bugsnag-ruby/issues/555)
+  | [#565](https://github.com/bugsnag/bugsnag-ruby/pull/565)
+
+## 6.12.0 (28 Aug 2019)
+
+### Enhancements
+
+* Add Ruby (and other framework) version strings to report and session payloads (device.runtimeVersions).
+  | [560](https://github.com/bugsnag/bugsnag-ruby/pull/560)
+
+* Allow symbols in breadcrumb meta data.
+  | [#563](https://github.com/bugsnag/bugsnag-ruby/pull/563)
+  | [directionless](https://github.com/directionless)
+
+### Fixes
+
+* Use `Module#prepend` for Rake integration when on a new enough Ruby version
+  to avoid infinite mutual recursion issues when something else monkey patches
+  `Rake::Task`.
+  | [#556](https://github.com/bugsnag/bugsnag-ruby/issues/556)
+  | [#559](https://github.com/bugsnag/bugsnag-ruby/issues/559)
+
+* Handle `nil` values for the `job` block parameter for the Que error notifier.
+  This occurs under some conditions such as database connection failures.
+  | [#545](https://github.com/bugsnag/bugsnag-ruby/issues/545)
+  | [#548](https://github.com/bugsnag/bugsnag-ruby/pull/548)
+
+## 6.11.1 (22 Jan 2019)
+
+### Fixes
+
+* Fix issue with unnecessary meta_data being logged during breadcrumb validation.
+  | [#530](https://github.com/bugsnag/bugsnag-ruby/pull/530)
+
+## 6.11.0 (17 Jan 2019)
+
+**Note**: this release alters the behaviour of the notifier to track sessions automatically.
+
+### Enhancements
+
+* Added Breadcrumbs.  Breadcrumbs allow you to track events that may have led
+up to an error, such as handled errors, page redirects, or SQL queries. For info on what
+is tracked and how you can customize the data that breadcrumbs collect, see the
+[Logging breadcrumbs](https://docs.bugsnag.com/platforms/ruby/other#logging-breadcrumbs)
+section of our documentation.
+  | [#525](https://github.com/bugsnag/bugsnag-ruby/pull/525)
+
+* Bugsnag will now capture automatically created sessions by default.
+  | [#523](https://github.com/bugsnag/bugsnag-ruby/pull/523)
+
+### Deprecated
+
+* The `endpoint` and `session_endpoint` configuration options are now deprecated but still supported. The [`set_endpoints`](https://docs.bugsnag.com/platforms/ruby/other/configuration-options#endpoints) method should be used instead. Note that session tracking will be disabled if the notify endpoint is configured but the sessions endpoint is not - this is to avoid inadvertently sending session payloads to the wrong server.
+
 ## 6.10.0 (05 Dec 2018)
 
 ### Enhancements

CONTRIBUTING.md

@@ -18,7 +18,12 @@ Thank you!
 -   Run the tests with and make sure they all pass
 
     ```
-    rake spec
+    bundle exec rake spec
+    ```
+-   You will need to add the following test dependencies:
+
+    ```
+    bundle install --with test --binstubs
     ```
 -   For adding a new integration (like support for a web framework or worker
     queue), include an example in the `example/` directory showing off what

Gemfile

@@ -1,14 +1,20 @@
 source "https://rubygems.org"
 
+ruby_version = Gem::Version.new(RUBY_VERSION)
+
 group :test, optional: true do
-    gem 'rake', RUBY_VERSION <= '1.9.3' ? '~> 11.3.0' : '~> 12.3.0'
-    gem 'rspec'
-    gem 'rspec-mocks'
-    gem 'rdoc', '~> 5.1.0'
-    gem 'pry'
-    gem 'addressable', '~> 2.3.8'
-    gem 'delayed_job' if RUBY_VERSION >= '2.2.2'
-    gem 'webmock', RUBY_VERSION <= '1.9.3' ? '2.3.2': '>2.3.2'
+  gem 'rake', ruby_version <= Gem::Version.new('1.9.3') ? '~> 11.3.0' : '~> 12.3.0'
+  gem 'rspec'
+  gem 'rspec-mocks'
+  gem 'rdoc', '~> 5.1.0'
+  gem 'pry'
+  gem 'addressable', '~> 2.3.8'
+  if ruby_version >= Gem::Version.new('2.2.2')
+    gem 'delayed_job', ruby_version < Gem::Version.new('2.5.0') ? '4.1.7': '>4.1.7'
+    gem 'i18n', ruby_version <= Gem::Version.new('2.3.0') ? '1.4.0' : '>1.4.0'
+  end
+  gem 'webmock', ruby_version <= Gem::Version.new('1.9.3') ? '2.3.2': '>2.3.2'
+  gem 'hashdiff', ruby_version <= Gem::Version.new('1.9.3') ? '0.3.8': '>0.3.8'
 end
 
 group :coverage, optional: true do
@@ -21,15 +27,17 @@ group :rubocop, optional: true do
 end
 
 group :sidekiq, optional: true do
-  gem 'sidekiq', '~> 5.0.4'
+  gem 'sidekiq', '~> 5.2.7'
+  # redis 4.1.2 dropped support for Ruby 2.2
+  gem 'redis', ruby_version < Gem::Version.new('2.3.0') ? '4.1.1' : '>= 4.1.2'
 end
 
 group :doc, optional: true do
   gem 'hanna-nouveau'
 end
 
 group :maze, optional: true do
-  gem 'bugsnag-maze-runner', git: 'https://github.com/bugsnag/maze-runner' if RUBY_VERSION >= '2.0.0'
+  gem 'bugsnag-maze-runner', git: 'https://github.com/bugsnag/maze-runner' if ruby_version >= Gem::Version.new('2.0.0')
 end
 
 gemspec

README.md

@@ -1,5 +1,5 @@
-# Bugsnag exception reporter for Ruby
-[![build status](https://travis-ci.org/bugsnag/bugsnag-ruby.svg?branch=master)](https://travis-ci.org/bugsnag/bugsnag-ruby)
+# Bugsnag error monitoring & exception reporter for Ruby
+[![build status](https://travis-ci.com/bugsnag/bugsnag-ruby.svg?branch=master)](https://travis-ci.com/bugsnag/bugsnag-ruby)
 
 
 The Bugsnag exception reporter for Ruby gives you instant notification of exceptions thrown from your **[Rails](https://www.bugsnag.com/platforms/rails)**, **Sinatra**, **Rack** or **plain Ruby** app. Any uncaught exceptions will trigger a notification to be sent to your Bugsnag project.
@@ -10,6 +10,7 @@ The Bugsnag exception reporter for Ruby gives you instant notification of except
 * Report handled exceptions
 * Attach user information to determine how many people are affected by a crash
 * Send customized diagnostic data
+* Track events that occur leading up to a crash
 
 ## Getting started
 
@@ -33,7 +34,7 @@ The Bugsnag exception reporter for Ruby gives you instant notification of except
     * [Rake](https://docs.bugsnag.com/platforms/ruby/rake/configuration-options)
     * [Sidekiq](https://docs.bugsnag.com/platforms/ruby/sidekiq/configuration-options)
     * [Other Ruby apps](https://docs.bugsnag.com/platforms/ruby/other/configuration-options)
-* Check out some [example apps integrated with Bugsnag](https://github.com/bugsnag/bugsnag-example-apps/tree/master/apps/ruby) using Rails, Sinatra, Padrino, and more.
+* Check out some [example apps integrated with Bugsnag](https://github.com/bugsnag/bugsnag-ruby/tree/master/example) using Rails, Sinatra, Padrino, and more.
 * [Search open and closed issues](https://github.com/bugsnag/bugsnag-ruby/issues?utf8=✓&q=is%3Aissue) for similar problems
 * [Report a bug or request a feature](https://github.com/bugsnag/bugsnag-ruby/issues/new)
 

UPGRADING.md

@@ -67,3 +67,25 @@ guide](https://docs.bugsnag.com/api/deploy-tracking/capistrano/) for more inform
   + Bugsnag.configuration.logger.warn "Warn message"
   + Bugsnag.configuration.logger.debug "Debug message"
   ```
+
+#### Middleware
+
+* If you previously accessed objects directly through `notification.exceptions`, this has now moved to `notification.raw_exceptions`
+
+  ```diff
+  class ExampleMiddleware
+    def initialize(bugsnag)
+      @bugsnag = bugsnag
+    end
+
+    def call(report)
+  -   exception = report.exceptions.first
+  +   exception = report.raw_exceptions.first
+      status = report.response.status
+      
+      # do stuff
+      
+      @bugsnag.call(report)
+    end
+  end
+  ```

VERSION

@@ -1 +1 @@
-6.10.0
+6.12.0

example/rails-51/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../..
   specs:
-    bugsnag (6.6.4)
+    bugsnag (6.11.1)
       concurrent-ruby (~> 1.0)
 
 GEM
@@ -101,7 +101,7 @@ GEM
     pg (1.0.0)
     public_suffix (3.0.2)
     puma (3.11.2)
-    que (0.12.1)
+    que (0.14.3)
     rack (2.0.4)
     rack-protection (2.0.1)
       rack
@@ -234,4 +234,4 @@ DEPENDENCIES
   web-console (>= 3.3.0)
 
 BUNDLED WITH
-   1.16.0
+   2.0.2

example/rails-51/README.md

@@ -56,18 +56,37 @@ Navigate to the `/sidekiq` page and run any of the examples using the links prov
 
 The worker code can be found in `app/workers/sidekiq_workers.rb`.
 
+To process the jobs, run Sidekiq using the following command:
+
+```shell
+bundle exec sidekiq
+```
+
 ## Que in Rails
 
 Que requires a database backend in order to queue jobs.  By default this database will be PostgreSQL although this can be changed via options as detailed in [the que documentation](https://github.com/chanks/que).
 
-Once PostgreSQL is set up as detailed using [the PostgreSQL documentation](https://www.postgresql.org/docs/), ensure Que can connect correctly before running and of the following examples. You may need to configure your connection in the `config/database.yml` file.
+Once PostgreSQL is set up as detailed using [the PostgreSQL documentation](https://www.postgresql.org/docs/), ensure Que can connect correctly before running any of the following examples which reference a `quedb` that can be created with the following command:
+
+```shell
+createdb quedb
+```
+
+You can configure your connection in the `config/database.yml` file.
 
 ### Configuration
 
+All tasks run with Que should set the rails environment to `que`.  This ensures that the correct database and connection settings are used.
+Do this by prepending `RAILS_ENV=que` before each command, or run:
+
+```shell
+export RAILS_ENV=que
+```
+
 Ensure that the initial Que setup is complete by running:
 
 ```shell
-bundle exec bin/rake que:install
+bundle exec bin/rails generate que:install
 ```
 
 and

example/rails-51/config/database.yml

@@ -5,10 +5,16 @@
 #   gem 'sqlite3'
 #
 default: &default
+  adapter: sqlite3
+  pool: 5
+  timeout: 5000
+
+que:
   adapter: postgresql
   pool: <%= ENV.fetch("RAILS_MAX_THREADS") { 5 } %>
   host: localhost
   timeout: 5000
+  database: quedb
 
 development:
   <<: *default