bugsnag 6.15.0 → 6.27.1

data/features/sidekiq.feature

@@ -1,30 +0,0 @@
-Feature: Bugsnag raises errors in Sidekiq workers
-
-Scenario: An unhandled RuntimeError sends a report
-  Given I run the service "sidekiq" with the command "bundle exec rake sidekiq_tests:unhandled_error"
-  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 "UnhandledError@default"
-  And the event "severityReason.type" equals "unhandledExceptionMiddleware"
-  And the event "severityReason.attributes.framework" equals "Sidekiq"
-  And the exception "errorClass" equals "RuntimeError"
-  And the "file" of stack frame 0 equals "/app/app.rb"
-  And the "lineNumber" of stack frame 0 equals 33
-  And the payload field "events.0.metaData.sidekiq" matches the appropriate Sidekiq unhandled payload
-  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
-
-Scenario: A handled RuntimeError can be notified
-  Given I run the service "sidekiq" with the command "bundle exec rake sidekiq_tests:handled_error"
-  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 "context" equals "HandledError@default"
-  And the event "severity" equals "warning"
-  And the event "severityReason.type" equals "handledException"
-  And the exception "errorClass" equals "RuntimeError"
-  And the payload field "events.0.metaData.sidekiq" matches the appropriate Sidekiq handled payload
-  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

data/features/steps/ruby_notifier_steps.rb

@@ -1,75 +0,0 @@
-Then(/^the "(.+)" of the top non-bugsnag stackframe equals (\d+|".+")$/) do |element, value|
-  stacktrace = read_key_path(Server.current_request[:body], 'events.0.exceptions.0.stacktrace')
-  frame_index = stacktrace.find_index { |frame| ! /.*lib\/bugsnag.*\.rb/.match(frame["file"]) }
-  steps %Q{
-    the "#{element}" of stack frame #{frame_index} equals #{value}
-  }
-end
-
-Then(/^the total sessionStarted count equals (\d+)$/) do |value|
-  session_counts = read_key_path(Server.current_request[:body], "sessionCounts")
-  total_count = session_counts.inject(0) { |count, session| count += session["sessionsStarted"] }
-  assert_equal(value, total_count)
-end
-
-
-# Due to an ongoing discussion on whether the `payload_version` needs to be present within the headers
-# and body of the payload, this step is a local replacement for the similar step present in the main
-# maze-runner library. Once the discussion is resolved this step should be removed and replaced in scenarios
-# with the main library version.
-Then("the request is valid for the error reporting API version {string} for the {string}") do |payload_version, notifier_name|
-  steps %Q{
-    Then the "Bugsnag-Api-Key" header equals "#{$api_key}"
-    And the payload field "apiKey" equals "#{$api_key}"
-    And the "Bugsnag-Payload-Version" header equals "#{payload_version}"
-    And the "Content-Type" header equals "application/json"
-    And the "Bugsnag-Sent-At" header is a timestamp
-
-    And the payload field "notifier.name" equals "#{notifier_name}"
-    And the payload field "notifier.url" is not null
-    And the payload field "notifier.version" is not null
-    And the payload field "events" is a non-empty array
-
-    And each element in payload field "events" has "severity"
-    And each element in payload field "events" has "severityReason.type"
-    And each element in payload field "events" has "unhandled"
-    And each element in payload field "events" has "exceptions"
-  }
-end
-
-Given("I start the rails service") do
-  rails_version = ENV["RAILS_VERSION"]
-  steps %Q{
-    When I start the service "rails#{rails_version}"
-    And I wait for the host "rails#{rails_version}" to open port "3000"
-  }
-end
-
-When("I navigate to the route {string} on the rails app") do |route|
-  rails_version = ENV["RAILS_VERSION"]
-  steps %Q{
-    When I open the URL "http://rails#{rails_version}:3000#{route}"
-  }
-end
-
-Then("the payload field {string} matches the appropriate Sidekiq handled payload") do |field|
-  if ENV["SIDEKIQ_VERSION"] == "~> 2"
-    created_at_present = "false"
-  else
-    created_at_present = "true"
-  end
-  steps %Q{
-    And the payload field "#{field}" matches the JSON fixture in "features/fixtures/sidekiq/payloads/handled_metadata_ca_#{created_at_present}.json"
-  }
-end
-
-Then("the payload field {string} matches the appropriate Sidekiq unhandled payload") do |field|
-  if ENV["SIDEKIQ_VERSION"] == "~> 2"
-    created_at_present = "false"
-  else
-    created_at_present = "true"
-  end
-  steps %Q{
-    And the payload field "#{field}" matches the JSON fixture in "features/fixtures/sidekiq/payloads/unhandled_metadata_ca_#{created_at_present}.json"
-  }
-end

data/features/support/env.rb

@@ -1,23 +0,0 @@
-require 'fileutils'
-
-def install_fixture_gems
-  throw Error.new("Bugsnag.gem not found. Is this running in a docker-container?") unless File.exist?("/app/bugsnag.gem")
-  Dir.entries('features/fixtures').reject { |entry| ['.', '..'].include?(entry) }.each do |entry|
-    target_dir = "features/fixtures/#{entry}"
-    if File.directory?(target_dir)
-      `cp /app/bugsnag.gem #{target_dir}`
-      `gem unpack #{target_dir}/bugsnag.gem --target #{target_dir}/temp-bugsnag-lib`
-    end
-  end
-end
-
-AfterConfiguration do |config|
-  install_fixture_gems
-end
-
-Before do
-  Docker.compose_project_name = "#{rand.to_s}:#{Time.new.strftime("%s")}"
-  Runner.environment.clear
-  Runner.environment["BUGSNAG_API_KEY"] = $api_key
-  Runner.environment["BUGSNAG_ENDPOINT"] = "http://maze-runner:#{MOCK_API_PORT}"
-end

data/issue_template.md

@@ -1,48 +0,0 @@
-### Description
-<!-- A quick description of what you're trying to accomplish -->
-
-### Issue
-<!--
-  What went wrong? (If this issue is a general question or a proposed change,
-  feel free to delete this and subsequent sections.
--->
-
-### Environment
-
-Library versions:
-
-<!--
-  Paste the output of this command into the code block below:
-    bundle list | grep -E "(bugsnag|rails|sidekiq|que|sinatra|resque|shoryuken|mailman|delayed_job)"
--->
-```
-
-```
-
-- OS / OS version:
-- debug mode or production?:
-
-<!--
-  Below are a few approaches you might take to communicate the issue, in
-  descending order of awesomeness. Please choose one and feel free to delete
-  the others from this template.
--->
-### Example Repo
-
-- [ ] Create a minimal repository that can reproduce the issue after running
-  `bundle install` and `rackup` (or `rails server`, or `ruby some-script.rb`,
-  etc)
-- [ ] Link to it here:
-
-### Example code snippet
-
-```ruby
-require 'bugsnag'
-
-# (Insert code sample to reproduce the problem)
-```
-
-<!-- Error messages, if any -->
-```
-
-```

data/spec/breadcrumbs/breadcrumb_spec.rb

@@ -1,93 +0,0 @@
-# encoding: utf-8
-
-require 'spec_helper'
-
-require 'bugsnag/breadcrumbs/breadcrumb'
-
-RSpec.describe Bugsnag::Breadcrumbs::Breadcrumb do
-  describe "#name" do
-    it "is assigned in #initialize" do
-      breadcrumb = Bugsnag::Breadcrumbs::Breadcrumb.new("my message", nil, nil, nil)
-
-      expect(breadcrumb.name).to eq("my message")
-    end
-  end
-
-  describe "#type" do
-    it "is assigned in #initialize" do
-      breadcrumb = Bugsnag::Breadcrumbs::Breadcrumb.new(nil, "test type", nil, nil)
-
-      expect(breadcrumb.type).to eq("test type")
-    end
-  end
-
-  describe "#meta_data" do
-    it "is assigned in #initialize" do
-      breadcrumb = Bugsnag::Breadcrumbs::Breadcrumb.new(nil, nil, {:a => 1, :b => 2}, nil)
-
-      expect(breadcrumb.meta_data).to eq({:a => 1, :b => 2})
-    end
-  end
-
-  describe "#auto" do
-    it "defaults to false" do
-      breadcrumb = Bugsnag::Breadcrumbs::Breadcrumb.new(nil, nil, nil, nil)
-
-      expect(breadcrumb.auto).to eq(false)
-    end
-
-    it "is true if auto argument == :auto" do
-      breadcrumb = Bugsnag::Breadcrumbs::Breadcrumb.new(nil, nil, nil, :auto)
-
-      expect(breadcrumb.auto).to eq(true)
-    end
-
-    it "is false if auto argument is anything else" do
-      breadcrumb = Bugsnag::Breadcrumbs::Breadcrumb.new(nil, nil, nil, :manual)
-
-      expect(breadcrumb.auto).to eq(false)
-    end
-  end
-
-  describe "#timestamp" do
-    it "is stored as a timestamp" do
-      breadcrumb = Bugsnag::Breadcrumbs::Breadcrumb.new(nil, nil, nil, nil)
-
-      expect(breadcrumb.timestamp).to be_within(0.5).of Time.now.utc
-    end
-  end
-
-  describe "#ignore?" do
-    it "is not true by default" do
-      breadcrumb = Bugsnag::Breadcrumbs::Breadcrumb.new("my message", "test type", {:a => 1, :b => 2}, :manual)
-
-      expect(breadcrumb.ignore?).to eq(false)
-    end
-
-    it "is able to be set" do
-      breadcrumb = Bugsnag::Breadcrumbs::Breadcrumb.new("my message", "test type", {:a => 1, :b => 2}, :manual)
-      breadcrumb.ignore!
-
-      expect(breadcrumb.ignore?).to eq(true)
-    end
-  end
-
-  describe "#to_h" do
-    it "outputs as a hash" do
-      breadcrumb = Bugsnag::Breadcrumbs::Breadcrumb.new("my message", "test type", {:a => 1, :b => 2}, :manual)
-      output = breadcrumb.to_h
-
-      timestamp_regex = /^\d{4}\-\d{2}\-\d{2}T\d{2}:\d{2}:[\d\.]+Z$/
-
-      expect(output).to match(
-        :name => "my message",
-        :type => "test type",
-        :metaData => {
-          :a => 1,
-          :b => 2
-        },
-        :timestamp => eq(breadcrumb.timestamp.iso8601)
-      )
-    end
-  end
-end

data/spec/breadcrumbs/validator_spec.rb

@@ -1,176 +0,0 @@
-# encoding: utf-8
-require 'spec_helper'
-
-require 'bugsnag/breadcrumbs/breadcrumb'
-require 'bugsnag/breadcrumbs/validator'
-
-RSpec.describe Bugsnag::Breadcrumbs::Validator do
-  let(:enabled_automatic_breadcrumb_types) { Bugsnag::Breadcrumbs::VALID_BREADCRUMB_TYPES }
-  let(:auto) { false }
-  let(:name) { "Valid message" }
-  let(:type) { Bugsnag::Breadcrumbs::ERROR_BREADCRUMB_TYPE }
-  let(:meta_data) { {} }
-
-  describe "#validate" do
-    it "does not 'ignore!' a valid breadcrumb" 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)
-
-      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(config).to_not receive(:debug)
-
-      validator.validate(breadcrumb)
-    end
-
-    describe "tests meta_data types" do
-      it "accepts Strings, Numerics, Booleans, & nil" 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)
-
-        meta_data = {
-          :string => "This is a string",
-          :symbol => :this_is_a_symbol,
-          :integer => 12345,
-          :float => 12345.6789,
-          :false => false,
-          :true => true,
-          :nil => nil
-        }
-
-        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(config).to_not receive(:debug)
-
-        validator.validate(breadcrumb)
-      end
-
-      it "rejects Arrays, Hashes, and non-primitive objects" 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)
-
-        class TestClass
-        end
-
-        meta_data = {
-          :fine => 1,
-          :array => [1, 2, 3],
-          :hash => {
-            :a => 1
-          },
-          :object => TestClass.new
-        }
-
-        breadcrumb = instance_double(Bugsnag::Breadcrumbs::Breadcrumb, {
-          :auto => auto,
-          :name => name,
-          :type => type,
-          :meta_data => meta_data
-        })
-
-        expect(breadcrumb).to_not receive(:ignore!)
-        expected_string_1 = "Breadcrumb #{breadcrumb.name} meta_data array:Array has been dropped for having an invalid data type"
-        expected_string_2 = "Breadcrumb #{breadcrumb.name} meta_data hash:Hash has been dropped for having an invalid data type"
-        expected_string_3 = "Breadcrumb #{breadcrumb.name} meta_data object:TestClass has been dropped for having an invalid data type"
-        expect(config).to receive(:debug).with(expected_string_1)
-        expect(config).to receive(:debug).with(expected_string_2)
-        expect(config).to receive(:debug).with(expected_string_3)
-
-        # Confirms that the meta_data is being filtered
-        expect(breadcrumb).to receive(:meta_data=).with({
-          :fine => 1
-        })
-
-        validator.validate(breadcrumb)
-      end
-    end
-
-    it "tests type, defaulting to 'manual' if invalid" 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)
-
-      type = "Not a valid type"
-
-      breadcrumb = instance_double(Bugsnag::Breadcrumbs::Breadcrumb, {
-        :auto => auto,
-        :name => name,
-        :type => type,
-        :meta_data => meta_data,
-        :meta_data= => nil
-      })
-
-      expect(breadcrumb).to receive(:type=).with(Bugsnag::Breadcrumbs::MANUAL_BREADCRUMB_TYPE)
-      expect(breadcrumb).to_not receive(:ignore!)
-      expected_string = "Invalid type: #{type} for breadcrumb: #{breadcrumb.name}, defaulting to #{Bugsnag::Breadcrumbs::MANUAL_BREADCRUMB_TYPE}"
-      expect(config).to receive(:debug).with(expected_string)
-
-      validator.validate(breadcrumb)
-    end
-
-    describe "with enabled_automatic_breadcrumb_types set" do
-      it "rejects automatic breadcrumbs with rejected types" do
-        config = instance_double(Bugsnag::Configuration)
-        allowed_breadcrumb_types = []
-        allow(config).to receive(:enabled_automatic_breadcrumb_types).and_return(allowed_breadcrumb_types)
-        validator = Bugsnag::Breadcrumbs::Validator.new(config)
-
-        auto = true
-        type = Bugsnag::Breadcrumbs::ERROR_BREADCRUMB_TYPE
-
-        breadcrumb = instance_double(Bugsnag::Breadcrumbs::Breadcrumb, {
-          :auto => auto,
-          :name => name,
-          :type => type,
-          :meta_data => meta_data,
-          :meta_data= => nil
-        })
-
-        expect(breadcrumb).to receive(:ignore!)
-        expected_string = "Automatic breadcrumb of type #{Bugsnag::Breadcrumbs::ERROR_BREADCRUMB_TYPE} ignored: #{breadcrumb.name}"
-        expect(config).to receive(:debug).with(expected_string)
-
-        validator.validate(breadcrumb)
-      end
-
-      it "does not reject manual breadcrumbs with rejected types" do
-        config = instance_double(Bugsnag::Configuration)
-        allowed_breadcrumb_types = []
-        allow(config).to receive(:enabled_automatic_breadcrumb_types).and_return(allowed_breadcrumb_types)
-        validator = Bugsnag::Breadcrumbs::Validator.new(config)
-
-        type = Bugsnag::Breadcrumbs::ERROR_BREADCRUMB_TYPE
-
-        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(config).to_not receive(:debug)
-
-        validator.validate(breadcrumb)
-      end
-    end
-  end
-end