bugsnag 6.15.0 → 6.16.0

data/CONTRIBUTING.md

@@ -1,64 +0,0 @@
-
-## How to contribute
-
-We are glad you're here! First-time and returning contributors are welcome to
-add bug fixes and new integrations. If you are unsure about the direction of an
-enhancement or if it would be generally useful, feel free to open an issue or a
-work-in-progress pull request and ask for input.
-
-Thank you!
-
-### Getting started
-
--   [Fork](https://help.github.com/articles/fork-a-repo) the [library on github](https://github.com/bugsnag/bugsnag-ruby)
--   Commit and push until you are happy with your contribution
-
-### Polish
-
--   Run the tests with and make sure they all pass
-
-    ```
-    bundle exec rake spec
-    ```
--   Further information on installing and running the tests can be found in [the testing guide](TESTING.md)
-
-
-### Ship it!
-
--   [Make a pull request](https://help.github.com/articles/using-pull-requests)
-
-
-## How to release
-
-If you're a member of the core team, follow these instructions for releasing bugsnag-ruby.
-
-### First time setup
-
-* Create a Rubygems account
-* Get James/Simon to add you as contributor on bugsnag-ruby in Rubygems
-
-### Every time
-
-* Update `VERSION`
-* Update `CHANGELOG.md`
-* Update `README.md` if necessary
-* Commit/push your changes
-
-    ```
-    git add VERSION CHANGELOG.md README.md
-    git commit -m "Release v6.x.x"
-    git push origin master
-    ```
-
-* Release to rubygems
-
-    ```
-    gem build bugsnag.gemspec
-    gem push bugsnag-[version].gem
-    ```
-
-* Update the version running in the bugsnag-website project
-
-### Update docs.bugsnag.com
-
-Update the setup guides for Ruby (and its frameworks) with any new content.

data/Gemfile

@@ -1,50 +0,0 @@
-source "https://rubygems.org"
-
-ruby_version = Gem::Version.new(RUBY_VERSION.dup)
-
-group :test, optional: true do
-  gem 'rake', ruby_version <= Gem::Version.new('1.9.3') ? '~> 11.3.0' : '~> 12.3.0'
-  gem 'rspec'
-  gem 'rspec-mocks'
-  gem 'rdoc', ruby_version < Gem::Version.new('2.2.0') ? '4.3.0' : '~> 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'
-  if ruby_version >= Gem::Version.new('2.7.0')
-    gem 'did_you_mean', '~> 1.4.0'
-  elsif ruby_version >= Gem::Version.new('2.5.0')
-    gem 'did_you_mean', '~> 1.3.1'
-  elsif ruby_version >= Gem::Version.new('2.4.0')
-    gem 'did_you_mean', '~> 1.1.0'
-  elsif ruby_version >= Gem::Version.new('2.3.0')
-    gem 'did_you_mean', '~> 1.0.4'
-  end
-end
-
-group :coverage, optional: true do
-  gem 'simplecov'
-  gem 'coveralls'
-end
-
-group :rubocop, optional: true do
-  gem 'rubocop', '~> 0.83'
-end
-
-group :sidekiq, optional: true do
-  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'
-  # rack 2.2.0 dropped support for Ruby 2.2
-  gem 'rack', ruby_version < Gem::Version.new('2.3.0') ? '< 2.2.0' : '~> 2.2'
-end
-
-group :doc, optional: true do
-  gem 'hanna-nouveau'
-end
-
-gemspec

data/Rakefile

@@ -1,37 +0,0 @@
-# encoding: utf-8
-
-require 'rdoc/task'
-RDoc::Task.new do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.rdoc_files.include('README.md')
-  rdoc.rdoc_files.include('CONTRIBUTING.md')
-  rdoc.rdoc_files.include('CHANGELOG.md')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-  rdoc.options.push '-f', 'hanna'
-  rdoc.markup = 'markdown'
-end
-
-# RSpec tasks
-require 'rspec/core'
-require "rspec/core/rake_task"
-RSpec::Core::RakeTask.new(:spec) do |task|
-  integration_exclusions = []
-  begin
-    require 'sidekiq/testing'
-  rescue LoadError
-    puts "Skipping sidekiq tests, missing dependencies"
-    integration_exclusions << 'sidekiq'
-  end
-  begin
-    require 'delayed_job'
-  rescue LoadError
-    puts "Skipping delayed_job tests, missing dependencies"
-    integration_exclusions << 'delayed_job'
-  end
-  if integration_exclusions.length > 0
-    pattern = integration_exclusions.join(',')
-    task.rspec_opts = " --exclude-pattern **/integrations/{#{pattern}}_spec.rb"
-  end
-end
-
-task :default  => :spec

data/TESTING.md

@@ -1,81 +0,0 @@
-# Testing the Ruby Bugsnag notifier
-
-## Unit tests
-
-To run locally:
-
-```
-bundle install --with test sidekiq --binstubs
-bundle exec rake
-```
-
-To run within a different environment, set `RUBY_TEST_VERSION` to your desired Ruby version, then run:
-
-```
-RUBY_TEST_VERSION=2.6 docker-compose up --build ruby-unit-tests
-```
-
-To run the unit tests against JRuby, run:
-
-```
-docker-compose up --build jruby-unit-tests
-```
-
-## End-to-end tests
-
-These tests are implemented with our notifier testing tool [Maze Runner](https://github.com/bugsnag/maze-runner).
-
-End to end tests are written in cucumber-style `.feature` files, and need Ruby-backed "steps" in order to know what to run. The tests are located in the top level [`features`](/features/) directory.
-
-Maze runner's CLI and the test fixtures are containerised so you'll need Docker (and Docker Compose) to run them.
-
-__Note: only Bugsnag employees can run the end-to-end tests.__ We have dedicated test infrastructure and private BrowserStack credentials which can't be shared outside of the organisation.
-
-##### Authenticating with the private container registry
-
-You'll need to set the credentials for the aws profile in order to access the private docker registry:
-
-```
-aws configure --profile=opensource
-```
-
-Subsequently you'll need to run the following commmand to authenticate with the registry:
-
-```
-aws ecr get-login-password --profile=opensource | docker login --username AWS --password-stdin 855461928731.dkr.ecr.us-west-1.amazonaws.com
-```
-
-__Your session will periodically expire__, so you'll need to run this command to re-authenticate when that happens.
-
-### Running the end to end tests
-
-Once registered with the remote repository, build the test container:
-
-```
-docker-compose build ruby-maze-runner
-```
-
-Configure the tests to be run in the following way:
-
-- Determine the Ruby version to be tested using the environment variable `RUBY_TEST_VERSION` e.g. `RUBY_TEST_VERSION=2.6`
-- If testing rails, set the rails version to be tested using the environment variable `RAILS_VERSION` e.g. `RAILS_VERSION=3`
-- If testing sidekiq, set the version to be tested using the environment variable `SIDEKIQ_VERSION` as the bundler version,  e.g. `SIDEKIQ_VERSION="~> 2"`
-
-When running the end-to-end tests, you'll want to restrict the feature files run to the specific test features for the platform.  This is done using the Cucumber CLI syntax at the end of the `docker-compose run ruby-maze-runner` command, i.e:
-
-```
-RUBY_TEST_VERSION=2.6 RAILS_VERSION=6 docker-compose run --use-aliases ruby-maze-runner features/rails_features --tags "@rails6"
-```
-
-- Plain ruby tests should target `features/plain_features`
-- Sidekiq tests should target `features/sidekiq.feature`
-- Delayed job tests should target `features/delayed_job.feature`
-- Rails test should target `features/rails_features`. In addition, the tag syntax should be used to specify which of the scenarios within those files are run.  For example rails 3 test should feature the tag `"@rails3"`
-
-In order to target specific features the exact `.feature` file can be specified, i.e:
-
-```
-RUBY_TEST_VERSION=2.6 RAILS_VERSION=6 docker-compose run --use-aliases ruby-maze-runner features/rails_features/app_version.feature --tags "@rails6"
-```
-
-In order to avoid running flakey or unfinished tests, the tag `"not @wip"` can be added to the tags option. This is recommended for all CI runs. If a tag is already specified, this should be added using the `and` keyword, e.g. `--tags "@rails6 and not @wip"`

data/UPGRADING.md

@@ -1,91 +0,0 @@
-# Upgrade Guide
-
-## 5.x to 6.x
-
-_Our Ruby library has gone through some major improvements and there are a few
-changes required to use the new integrations_
-
-#### Capistrano and deploys
-
-Support for notifying Bugsnag of deployments has been separated into a separate
-gem named `bugsnag-capistrano`. See the [integration
-guide](https://docs.bugsnag.com/api/deploy-tracking/capistrano/) for more information.
-
-
-#### Configuration
-
-* `Configuration.use_ssl` has been removed. Include the preferred protocol in `Configuration.endpoint` instead.
-  ```diff
-    Bugsnag.configure do |config|
-  -   config.use_ssl = true
-  -   config.endpoint = 'myserver.example.com'
-  +   config.endpoint = 'https://myserver.example.com'
-    end
-  ```
-* `Configuration.ignore_classes` now no longer accepts strings. Use classes directly instead.
-* `Configuration.delay_with_resque` has been removed
-* `Configuration.vendor_paths` has been removed
-* `Configuration.params_filters` has been renamed to `Configuration.meta_data_filters` to be clearer
-* `Configuration.proxy_host` will now default to `ENV['http_proxy']` if set. It can still be manually set.
-
-#### Notifying
-
-* `notify` now only supports block syntax. Replace usage of the overrides hash with a block
-
-  ```diff
-  - Bugsnag.notify(e, {severity: 'info'})
-  + Bugsnag.notify(e) do |report|
-  +   report.severity = 'info'
-  + end
-  ```
-
-* `Bugsnag.notify_or_ignore` and `Bugsnag.auto_notify` have been removed. Call `notify` directly instead.
-* `after_notify_callbacks` has been removed
-* `Bugsnag::Notification` has been renamed to `Bugsnag::Report`
-
-#### Logging
-
-* `config.debug` boolean has been removed. Set the logger level directly
-
-  ```diff
-  + require 'logger'
-
-    Bugsnag.configure do |config|
-      # .. set API key and other properties
-  -   config.debug = true
-  +   config.logger.level = Logger::DEBUG
-    end
-  ```
-
-* Log accessor functions on the `Bugsnag` object no longer exist. Logging must now be accessed through the configuration object:
-
-  ```diff
-  - Bugsnag.log "Log message"
-  - Bugsnag.warn "Warn message"
-  - Bugsnag.debug "Debug message"
-  + Bugsnag.configuration.logger.info "Info message"
-  + 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
-  ```

data/docker-compose.yml

@@ -1,46 +0,0 @@
-version: '3.6'
-services:
-  ruby-maze-runner:
-    build:
-      context: .
-      dockerfile: dockerfiles/Dockerfile.ruby-maze-runner
-      target: ruby-maze-runner
-    environment:
-      NETWORK_NAME: "${BUILDKITE_JOB_ID:-ruby-maze-runner}-${RUBY_TEST_VERSION:-local}"
-      BUILDKITE_JOB_ID:
-      RAILS_VERSION:
-      SIDEKIQ_VERSION:
-      RUBY_TEST_VERSION:
-      VERBOSE:
-      DEBUG:
-    networks:
-      default:
-        aliases:
-          - maze-runner
-    volumes:
-      - /var/run/docker.sock:/var/run/docker.sock
-
-  ruby-unit-tests:
-    build:
-      context: .
-      dockerfile: dockerfiles/Dockerfile.ruby-unit-tests
-      args:
-        - RUBY_TEST_VERSION
-        - GEMSETS=${GEMSETS:-test}
-        - BUNDLE_VERSION=${BUNDLE_VERSION:-1.12.0}
-    environment:
-      COVERALLS_REPO_TOKEN:
-      GEMSETS:
-      CI:
-
-  jruby-unit-tests:
-    build:
-      context: .
-      dockerfile: dockerfiles/Dockerfile.jruby-unit-tests
-      args:
-        - GEMSETS=${GEMSETS:-test}
-        - BUNDLE_VERSION=${BUNDLE_VERSION:-1.12.0}
-
-networks:
-  default:
-    name: ${BUILDKITE_JOB_ID:-ruby-maze-runner}-${RUBY_TEST_VERSION:-local}

data/dockerfiles/Dockerfile.jruby-unit-tests

@@ -1,13 +0,0 @@
-FROM jruby:latest
-
-RUN apt-get update && apt-get install -y git
-
-WORKDIR /app/
-
-COPY . .
-ARG BUNDLE_VERSION
-ARG GEMSETS
-RUN gem install bundler -v $BUNDLE_VERSION
-RUN bundle _${BUNDLE_VERSION}_ install --with "$GEMSETS" --binstubs
-
-CMD ["bundle", "exec", "./bin/rake", "spec"]

data/dockerfiles/Dockerfile.ruby-maze-runner

@@ -1,26 +0,0 @@
-FROM ruby:2.6 as ruby-package-builder
-
-RUN gem install bundler
-
-WORKDIR /app
-
-COPY bugsnag.gemspec Gemfile VERSION ./
-
-RUN bundle install
-
-COPY  CHANGELOG.md CONTRIBUTING.md TESTING.md LICENSE.txt Rakefile README.md UPGRADING.md .gitignore .rdoc_options .rspec .rubocop.yml .rubocop_todo.yml issue_template.md docker-compose.yml ./
-COPY .buildkite ./.buildkite
-COPY .git ./.git
-COPY .github ./.github
-COPY dockerfiles ./dockerfiles
-COPY features ./features
-COPY lib ./lib
-COPY spec ./spec
-
-RUN gem build bugsnag.gemspec
-
-# The maze-runner node tests
-FROM 855461928731.dkr.ecr.us-west-1.amazonaws.com/maze-runner:latest-cli as ruby-maze-runner
-WORKDIR /app/
-COPY features ./features
-COPY --from=ruby-package-builder /app/bugsnag-*.gem bugsnag.gem

data/dockerfiles/Dockerfile.ruby-unit-tests

@@ -1,12 +0,0 @@
-ARG RUBY_TEST_VERSION
-FROM ruby:$RUBY_TEST_VERSION
-
-WORKDIR /app/
-
-COPY . .
-ARG BUNDLE_VERSION
-ARG GEMSETS
-RUN gem install bundler -v ${BUNDLE_VERSION}
-RUN bundle _${BUNDLE_VERSION}_ install --with "$GEMSETS" --binstubs
-
-CMD ["bundle", "exec", "./bin/rake", "spec"]

data/features/.gitignore

@@ -1 +0,0 @@
-temp-bugsnag-lib

data/features/delayed_job.feature

@@ -1,36 +0,0 @@
-Feature: Bugsnag detects errors in Delayed job workers
-
-Scenario: An unhandled RuntimeError sends a report with arguments
-  Given I run the service "delayed_job" with the command "bundle exec rake delayed_job_tests:fail_with_args"
-  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 true
-  And the event "severity" equals "error"
-  And the event "context" equals "TestModel.fail_with_args"
-  And the event "severityReason.type" equals "unhandledExceptionMiddleware"
-  And the event "severityReason.attributes.framework" equals "DelayedJob"
-  And the exception "errorClass" equals "RuntimeError"
-  And the event "metaData.job.class" equals "Delayed::Backend::ActiveRecord::Job"
-  And the event "metaData.job.id" is not null
-  And the event "metaData.job.attempt" equals 1
-  And the event "metaData.job.max_attempts" equals 1
-  And the event "metaData.job.payload.display_name" equals "TestModel.fail_with_args"
-  And the event "metaData.job.payload.method_name" equals "fail_with_args"
-  And the payload field "events.0.metaData.job.payload.args.0" equals "Test"
-
-Scenario: A handled exception sends a report
-  Given I run the service "delayed_job" with the command "bundle exec rake delayed_job_tests:notify_with_args"
-  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 event "severity" equals "warning"
-  And the event "context" equals "TestModel.notify_with_args"
-  And the event "severityReason.type" equals "handledException"
-  And the exception "errorClass" equals "RuntimeError"
-  And the event "metaData.job.class" equals "Delayed::Backend::ActiveRecord::Job"
-  And the event "metaData.job.id" is not null
-  And the event "metaData.job.attempt" equals 1
-  And the event "metaData.job.max_attempts" equals 1
-  And the event "metaData.job.payload.display_name" equals "TestModel.notify_with_args"
-  And the event "metaData.job.payload.method_name" equals "notify_with_args"
-  And the payload field "events.0.metaData.job.payload.args.0" equals "Test"