bugsnag 6.7.3 → 6.8.0

data/features/rails_features/send_code.feature

@@ -0,0 +1,58 @@
+Feature: Send code
+
+Background:
+  Given I set environment variable "MAZE_API_KEY" to "a35a2a72bd230ac0aa0f52715bbdc6aa"
+  And I set environment variable "APP_PATH" to "/usr/src"
+  And I configure the bugsnag endpoint
+
+Scenario Outline: Send_code can be updated in an initializer
+  Given I set environment variable "RUBY_VERSION" to "<ruby_version>"
+  And I set environment variable "MAZE_SEND_CODE" to "false"
+  And I start the service "rails<rails_version>"
+  And I wait for the app to respond on port "6128<rails_version>"
+  When I navigate to the route "/send_code/initializer" on port "6128<rails_version>"
+  Then I should receive a request
+  And the request is a valid for the error reporting API
+  And the payload field "events" is an array with 1 element
+  And the event "exceptions.0.stacktrace.0.code" is null
+
+  Examples:
+    | ruby_version | rails_version |
+    | 2.0          | 3             |
+    | 2.1          | 3             |
+    | 2.2          | 3             |
+    | 2.2          | 4             |
+    | 2.2          | 5             |
+    | 2.3          | 3             |
+    | 2.3          | 4             |
+    | 2.3          | 5             |
+    | 2.4          | 3             |
+    | 2.4          | 5             |
+    | 2.5          | 3             |
+    | 2.5          | 5             |
+
+Scenario Outline: Send_code can be updated after an initializer
+  Given I set environment variable "RUBY_VERSION" to "<ruby_version>"
+  And I start the service "rails<rails_version>"
+  And I wait for the app to respond on port "6128<rails_version>"
+  When I navigate to the route "/send_code/after" on port "6128<rails_version>"
+  Then I should receive a request
+  And the request is a valid for the error reporting API
+  And the request contained the api key "a35a2a72bd230ac0aa0f52715bbdc6aa"
+  And the payload field "events" is an array with 1 element
+  And the event "exceptions.0.stacktrace.0.code" is null
+
+  Examples:
+    | ruby_version | rails_version |
+    | 2.0          | 3             |
+    | 2.1          | 3             |
+    | 2.2          | 3             |
+    | 2.2          | 4             |
+    | 2.2          | 5             |
+    | 2.3          | 3             |
+    | 2.3          | 4             |
+    | 2.3          | 5             |
+    | 2.4          | 3             |
+    | 2.4          | 5             |
+    | 2.5          | 3             |
+    | 2.5          | 5             |

data/features/rails_features/send_environment.feature

@@ -0,0 +1,38 @@
+Feature: Send environment
+
+Background:
+  Given I set environment variable "MAZE_API_KEY" to "a35a2a72bd230ac0aa0f52715bbdc6aa"
+  And I set environment variable "APP_PATH" to "/usr/src"
+  And I configure the bugsnag endpoint
+
+Scenario Outline: Send_environment should send environment in handled errors when true
+  Given I set environment variable "RUBY_VERSION" to "<ruby_version>"
+  And I set environment variable "MAZE_SEND_ENVIRONMENT" to "true"
+  And I start the service "rails<rails_version>"
+  And I wait for the app to respond on port "6128<rails_version>"
+  When I navigate to the route "/send_environment/initializer" on port "6128<rails_version>"
+  Then I should receive a request
+  And the request is a valid for the error reporting API
+  And the request used the Ruby notifier
+  And the request contained the api key "a35a2a72bd230ac0aa0f52715bbdc6aa"
+  And the payload field "events" is an array with 1 element
+  And the exception "errorClass" equals "RuntimeError"
+  And the exception "message" starts with "handled string"
+  And the event "metaData.environment.REQUEST_METHOD" equals "GET"
+  And the event "metaData.environment.railsVersion" is not null
+  And the event "app.type" equals "rails"
+
+  Examples:
+    | ruby_version | rails_version |
+    | 2.0          | 3             |
+    | 2.1          | 3             |
+    | 2.2          | 3             |
+    | 2.2          | 4             |
+    | 2.2          | 5             |
+    | 2.3          | 3             |
+    | 2.3          | 4             |
+    | 2.3          | 5             |
+    | 2.4          | 3             |
+    | 2.4          | 5             |
+    | 2.5          | 3             |
+    | 2.5          | 5             |

data/features/rails_features/unhandled.feature

@@ -0,0 +1,40 @@
+Feature: Unhandled exceptions support
+
+Background:
+  Given I set environment variable "MAZE_API_KEY" to "a35a2a72bd230ac0aa0f52715bbdc6aa"
+  And I set environment variable "APP_PATH" to "/usr/src"
+  And I configure the bugsnag endpoint
+
+Scenario Outline: Unhandled RuntimeError
+  Given I set environment variable "RUBY_VERSION" to "<ruby_version>"
+  And I start the service "rails<rails_version>"
+  And I wait for the app to respond on port "6128<rails_version>"
+  When I navigate to the route "/unhandled/error" on port "6128<rails_version>"
+  Then I should receive a request
+  And the request is a valid for the error reporting API
+  And the request used the Ruby notifier
+  And the request contained the api key "a35a2a72bd230ac0aa0f52715bbdc6aa"
+  And the payload field "events" is an array with 1 element
+  And the event "unhandled" is true
+  And the exception "errorClass" equals "NameError"
+  And the exception "message" starts with "undefined local variable or method `generate_unhandled_error' for #<UnhandledController"
+  And the event "app.type" equals "rails"
+  And the event "metaData.request.url" ends with "/unhandled/error"
+  And the event "severity" equals "error"
+  And the event "severityReason.type" is "unhandledExceptionMiddleware"
+  And the event "severityReason.attributes.framework" is "Rack"
+
+  Examples:
+    | ruby_version | rails_version |
+    | 2.0          | 3             |
+    | 2.1          | 3             |
+    | 2.2          | 3             |
+    | 2.2          | 4             |
+    | 2.2          | 5             |
+    | 2.3          | 3             |
+    | 2.3          | 4             |
+    | 2.3          | 5             |
+    | 2.4          | 3             |
+    | 2.4          | 5             |
+    | 2.5          | 3             |
+    | 2.5          | 5             |

data/features/rails_features/user_info.feature

@@ -0,0 +1,88 @@
+Feature: Capture user information
+
+Background:
+  Given I set environment variable "MAZE_API_KEY" to "a35a2a72bd230ac0aa0f52715bbdc6aa"
+  And I set environment variable "APP_PATH" to "/usr/src"
+  And I configure the bugsnag endpoint
+
+Scenario Outline: Warden user information is sent
+  Given I set environment variable "RUBY_VERSION" to "<ruby_version>"
+  And I start the service "rails<rails_version>"
+  And I wait for the app to respond on port "6128<rails_version>"
+  When I navigate to the route "/warden/create" on port "6128<rails_version>"
+  And I navigate to the route "/warden/<route>?email=testtest@test.test" on port "6128<rails_version>"
+  Then I should receive a request
+  And the request is a valid for the error reporting API
+  And the request used the Ruby notifier
+  And the request contained the api key "a35a2a72bd230ac0aa0f52715bbdc6aa"
+  And the payload field "events" is an array with 1 element
+  And the event "user.email" equals "testtest@test.test"
+  And the event "user.name" equals "Warden User"
+  And the event "user.first_name" equals "Warden"
+  And the event "user.last_name" equals "User"
+
+  Examples:
+    | ruby_version | rails_version | route     |
+    | 2.0          | 3             | handled   |
+    | 2.0          | 3             | unhandled |
+    | 2.1          | 3             | handled   |
+    | 2.1          | 3             | unhandled |
+    | 2.2          | 3             | handled   |
+    | 2.2          | 3             | unhandled |
+    | 2.3          | 3             | handled   |
+    | 2.3          | 3             | unhandled |
+    | 2.4          | 3             | handled   |
+    | 2.4          | 3             | unhandled |
+    | 2.5          | 3             | handled   |
+    | 2.5          | 3             | unhandled |
+
+
+Scenario Outline: Devise user information is sent
+  Given I set environment variable "RUBY_VERSION" to "<ruby_version>"
+  And I start the service "rails<rails_version>"
+  And I wait for the app to respond on port "6128<rails_version>"
+  When I navigate to the route "/devise/create" on port "6128<rails_version>"
+  And I navigate to the route "/devise/<route>" on port "6128<rails_version>"
+  Then I should receive a request
+  And the request is a valid for the error reporting API
+  And the request used the Ruby notifier
+  And the request contained the api key "a35a2a72bd230ac0aa0f52715bbdc6aa"
+  And the payload field "events" is an array with 1 element
+  And the event "user.email" equals "test+test@test.test"
+  And the event "user.name" equals "Devise User"
+  And the event "user.first_name" equals "Devise"
+  And the event "user.last_name" equals "User"
+
+  Examples:
+    | ruby_version | rails_version | route     |
+    | 2.2          | 4             | handled   |
+    | 2.2          | 4             | unhandled |
+    | 2.3          | 4             | handled   |
+    | 2.3          | 4             | unhandled |
+
+Scenario Outline: Clearance user information is sent
+  Given I set environment variable "RUBY_VERSION" to "<ruby_version>"
+  And I start the service "rails<rails_version>"
+  And I wait for the app to respond on port "6128<rails_version>"
+  When I navigate to the route "/clearance/create" on port "6128<rails_version>"
+  And I navigate to the route "/clearance/<route>" on port "6128<rails_version>"
+  Then I should receive a request
+  And the request is a valid for the error reporting API
+  And the request used the Ruby notifier
+  And the request contained the api key "a35a2a72bd230ac0aa0f52715bbdc6aa"
+  And the payload field "events" is an array with 1 element
+  And the event "user.email" equals "testtest@test.test"
+  And the event "user.name" equals "Clearance User"
+  And the event "user.first_name" equals "Clearance"
+  And the event "user.last_name" equals "User"
+
+  Examples:
+    | ruby_version | rails_version | route     |
+    | 2.2          | 5             | handled   |
+    | 2.2          | 5             | unhandled |
+    | 2.3          | 5             | handled   |
+    | 2.3          | 5             | unhandled |
+    | 2.4          | 5             | handled   |
+    | 2.4          | 5             | unhandled |
+    | 2.5          | 5             | handled   |
+    | 2.5          | 5             | unhandled |

data/features/sidekiq.feature

@@ -0,0 +1,96 @@
+Feature: Bugsnag raises errors in Sidekiq workers
+
+Background:
+  Given I set environment variable "BUGSNAG_API_KEY" to "a35a2a72bd230ac0aa0f52715bbdc6aa"
+  Given I set environment variable "MAZE_API_KEY" to "a35a2a72bd230ac0aa0f52715bbdc6aa"
+  And I set environment variable "APP_PATH" to "/usr/src"
+  And I configure the bugsnag endpoint
+
+Scenario Outline: An unhandled RuntimeError sends a report
+  And I set environment variable "RUBY_VERSION" to "<ruby version>"
+  And I set environment variable "SIDEKIQ_VERSION" to "<sidekiq_version>"
+  And I start the service "sidekiq"
+  And I run the command "bundle exec ruby initializers/UnhandledError.rb" on the service "sidekiq"
+  And I wait for 1 seconds
+  Then I should receive a request
+  And the request used the Ruby notifier
+  And the request used payload v4 headers
+  And the request contained the api key "a35a2a72bd230ac0aa0f52715bbdc6aa"
+  And the event "unhandled" is true
+  And the event "severity" is "error"
+  And the event "severityReason.type" is "unhandledExceptionMiddleware"
+  And the event "severityReason.attributes.framework" is "Sidekiq"
+  And the exception "errorClass" equals "RuntimeError"
+  And the "file" of stack frame 0 equals "/usr/src/app.rb"
+  And the "lineNumber" of stack frame 0 equals 33
+  And the payload field "events.0.metaData.sidekiq" matches the JSON fixture in "features/fixtures/sidekiq/payloads/unhandled_metadata_ca_<created_at_present>.json"
+  And the event "metaData.sidekiq.msg.created_at" is a parsable timestamp in seconds
+  And the event "metaData.sidekiq.msg.enqueued_at" is a parsable timestamp in seconds
+
+  Examples:
+  | ruby version | sidekiq_version | created_at_present |
+  | 1.9.3        | ~> 2            | false              |
+  | 2.0          | ~> 2            | false              |
+  | 2.0          | ~> 3            | true               |
+  | 2.1          | ~> 2            | false              |
+  | 2.1          | ~> 3            | true               |
+  | 2.2          | ~> 2            | false              |
+  | 2.2          | ~> 3            | true               |
+  | 2.2          | ~> 4            | true               |
+  | 2.2          | ~> 5            | true               |
+  | 2.3          | ~> 2            | false              |
+  | 2.3          | ~> 3            | true               |
+  | 2.3          | ~> 4            | true               |
+  | 2.3          | ~> 5            | true               |
+  | 2.4          | ~> 2            | false              |
+  | 2.4          | ~> 3            | true               |
+  | 2.4          | ~> 4            | true               |
+  | 2.4          | ~> 5            | true               |
+  | 2.5          | ~> 2            | false              |
+  | 2.5          | ~> 3            | true               |
+  | 2.5          | ~> 4            | true               |
+  | 2.5          | ~> 5            | true               |
+
+Scenario Outline: A handled RuntimeError can be notified
+  And I set environment variable "RUBY_VERSION" to "<ruby version>"
+  And I set environment variable "SIDEKIQ_VERSION" to "<sidekiq_version>"
+  And I start the service "sidekiq"
+  And I run the command "bundle exec ruby initializers/HandledError.rb" on the service "sidekiq"
+  And I wait for 1 seconds
+  Then I should receive a request
+  And the request used the Ruby notifier
+  And the request used payload v4 headers
+  And the request contained the api key "a35a2a72bd230ac0aa0f52715bbdc6aa"
+  And the event "unhandled" is false
+  And the event "severity" is "warning"
+  And the event "severityReason.type" is "handledException"
+  And the exception "errorClass" equals "RuntimeError"
+  And the "file" of stack frame 0 equals "/usr/src/app.rb"
+  And the "lineNumber" of stack frame 0 equals 24
+  And the payload field "events.0.metaData.sidekiq" matches the JSON fixture in "features/fixtures/sidekiq/payloads/handled_metadata_ca_<created_at_present>.json"
+  And the event "metaData.sidekiq.msg.created_at" is a parsable timestamp in seconds
+  And the event "metaData.sidekiq.msg.enqueued_at" is a parsable timestamp in seconds
+
+  Examples:
+  | ruby version | sidekiq_version | created_at_present |
+  | 1.9.3        | ~> 2            | false              |
+  | 2.0          | ~> 2            | false              |
+  | 2.0          | ~> 3            | true               |
+  | 2.1          | ~> 2            | false              |
+  | 2.1          | ~> 3            | true               |
+  | 2.2          | ~> 2            | false              |
+  | 2.2          | ~> 3            | true               |
+  | 2.2          | ~> 4            | true               |
+  | 2.2          | ~> 5            | true               |
+  | 2.3          | ~> 2            | false              |
+  | 2.3          | ~> 3            | true               |
+  | 2.3          | ~> 4            | true               |
+  | 2.3          | ~> 5            | true               |
+  | 2.4          | ~> 2            | false              |
+  | 2.4          | ~> 3            | true               |
+  | 2.4          | ~> 4            | true               |
+  | 2.4          | ~> 5            | true               |
+  | 2.5          | ~> 2            | false              |
+  | 2.5          | ~> 3            | true               |
+  | 2.5          | ~> 4            | true               |
+  | 2.5          | ~> 5            | true               |

data/features/steps/ruby_notifier_steps.rb

@@ -0,0 +1,77 @@
+require 'net/http'
+require 'open3'
+
+When("I configure the bugsnag endpoint") do
+  steps %Q{
+    When I set environment variable "MAZE_ENDPOINT" to "http://#{current_ip}:#{MOCK_API_PORT}"
+  }
+end
+
+When("I wait for the app to respond on port {string}") do |port|
+  max_attempts = ENV.include?('MAX_MAZE_CONNECT_ATTEMPTS')? ENV['MAX_MAZE_CONNECT_ATTEMPTS'].to_i : 10
+  attempts = 0
+  up = false
+  until (attempts >= max_attempts) || up
+    attempts += 1
+    begin
+      uri = URI("http://localhost:#{port}/")
+      response = Net::HTTP.get_response(uri)
+      up = (response.code == "200")
+    rescue EOFError
+    end
+    sleep 1
+  end
+  raise "App not ready in time!" unless up
+end
+
+When("I navigate to the route {string} on port {string}") do |route, port|
+  steps %Q{
+    When I open the URL "http://localhost:#{port}#{route}"
+    And I wait for 1 second
+  }
+end
+
+When("I set environment variable {string} to the current IP") do |env_var|
+  steps %Q{
+    When I set environment variable "#{env_var}" to "#{current_ip}"
+  }
+end
+When("I set environment variable {string} to the mock API port") do |env_var|
+  steps %Q{
+    When I set environment variable "#{env_var}" to "#{MOCK_API_PORT}"
+  }
+end
+When("I set environment variable {string} to the proxy settings with credentials {string}") do |env_var, credentials|
+  steps %Q{
+    When I set environment variable "#{env_var}" to "#{credentials}@#{current_ip}:#{MOCK_API_PORT}"
+  }
+end
+
+Then("the request used payload v4 headers") do
+  steps %Q{
+    Then the "bugsnag-api-key" header is not null
+    And the "bugsnag-payload-version" header equals "4.0"
+    And the "bugsnag-sent-at" header is a timestamp
+  }
+end
+
+Then("the request contained the api key {string}") do |api_key|
+  steps %Q{
+    Then the "bugsnag-api-key" header equals "#{api_key}"
+    And the payload field "apiKey" equals "#{api_key}"
+  }
+end
+
+Then("the request used the Ruby notifier") do
+  bugsnag_regex = /^http(s?):\/\/www.bugsnag.com/
+  steps %Q{
+    Then the payload field "notifier.name" equals "Ruby Bugsnag Notifier"
+    And the payload field "notifier.url" matches the regex "#{bugsnag_regex}"
+  }
+end
+
+Then("the event {string} is {string}") do |key, value|
+  steps %Q{
+    Then the event "#{key}" equals "#{value}"
+  }
+end

data/features/support/env.rb

@@ -0,0 +1,29 @@
+require 'open3'
+require 'os'
+
+Before do
+  find_default_docker_compose
+end
+
+def output_logs
+  $docker_services.each do |service|
+    logged_service = service[:service] == :all ? '' : service[:service]
+    command = "logs -t #{logged_service}"
+    begin
+      response = run_docker_compose_command(service[:file], command)
+    rescue => exception
+      response = "Couldn't retreive logs for #{service[:file]}:#{logged_service}"
+    end
+    STDOUT.puts response.is_a?(String) ? response : response.to_a
+  end
+end
+
+def current_ip
+  if OS.mac?
+    'host.docker.internal'
+  else
+    ip_addr = `ifconfig | grep -Eo 'inet (addr:)?([0-9]*\\\.){3}[0-9]*' | grep -v '127.0.0.1'`
+    ip_list = /((?:[0-9]*\.){3}[0-9]*)/.match(ip_addr)
+    ip_list.captures.first
+  end
+end

data/lib/bugsnag.rb

@@ -43,6 +43,8 @@ module Bugsnag
       yield(configuration) if block_given?
 
       check_key_valid if validate_api_key
+
+      register_at_exit
     end
 
     ##
@@ -111,6 +113,30 @@ module Bugsnag
       end
     end
 
+    ##
+    # Registers an at_exit function to automatically catch errors on exit
+    def register_at_exit
+      return if at_exit_handler_installed?
+      @exit_handler_added = true
+      at_exit do
+        if $!
+          Bugsnag.notify($!, true) do |report|
+            report.severity = 'error'
+            report.severity_reason = {
+              :type => Bugsnag::Report::UNHANDLED_EXCEPTION
+            }
+          end
+        end
+      end
+    end
+
+    ##
+    # Checks if an at_exit handler has been added
+    def at_exit_handler_installed?
+      @exit_handler_added ||= false
+    end
+
+    # Configuration getters
     ##
     # Returns the client's Configuration object, or creates one if not yet created.
     def configuration