bugsnag 6.7.2 → 6.7.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4a0ddb8da5fb920f1f434e58e955d26b979debe8
-  data.tar.gz: 65de67a4ae0dbb7356bd893100e7889d608cb8bb
+  metadata.gz: d0486c226a185af8162d31b64d545d235624e887
+  data.tar.gz: 1d29c838c3d026601bdc9f4c4b574338b3fe4635
 SHA512:
-  metadata.gz: 83327beda70eccb521332bdac2fd0c6b96eff182c508bdfacf67ba5465ceac51bb5c3f5df26ab5294c8c6051efc721eda05d9862d561de0a5b1bfe0184b746ad
-  data.tar.gz: cb10e69935a1682cba5aedcceee811097626a95a96a394bcbab0f22aaa77d427fd8ec00d1788a210b0c3354d4b1a8ea567066758fc3df01c1b909496a42a5fb1
+  metadata.gz: c7f23e849d19e4a8a92b8bc86900ea15d1f1c3651641398d961b765fb402ceaa466d3c097179df092c1628746ce6e723ba409dc2a6481ecba3acf4915610b5a3
+  data.tar.gz: f88ac4656275a100c8de76758c836fb75c336f5ba882d1ece6cbf81fc4cb4bdc4bcee9065df7781519122530581ba2310c503c041dc5bbb64ffa16ec960895ab

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,84 @@
+## Goal
+
+<!-- What is the intent of this change?
+e.g. "When initializing the Bugsnag client, it is currently difficult to (...)
+      this change simplifies the process by (...)"
+
+     "Improves the performance of data filtering"
+
+     "Adds additional test coverage to multi-threaded use of Configuration
+      objects"
+-->
+
+<!-- For new features, include design documentation:
+
+## Design
+
+Why was this approach to the goal used?
+
+-->
+
+## Changeset
+
+<!-- What structures or properties or functions were:
+
+### Added
+
+### Removed
+
+### Changed
+
+-->
+
+## Tests
+
+<!-- How was this change tested? What manual and automated tests were
+     run/added? -->
+
+## Discussion
+
+### Alternative Approaches
+
+<!-- What other approaches were considered or discussed? -->
+
+### Outstanding Questions
+
+<!-- Are there any parts of the design or the implementation which seem
+     less than ideal and that could require additional discussion?
+     List here: -->
+
+### Linked issues
+
+<!--
+
+Fixes #
+Related to #
+
+-->
+
+## Review
+
+<!-- When submitting for review, consider the points for self-review and the
+     criteria which will be used for secondary review -->
+
+For the submitter, initial self-review:
+
+- [ ] Commented on code changes inline explain the reasoning behind the approach
+- [ ] Reviewed the test cases added for completeness and possible points for discussion
+- [ ] A changelog entry was added for the goal of this pull request
+- [ ] Check the scope of the changeset - is everything in the diff required for the pull request?
+- This pull request is ready for:
+  - [ ] Initial review of the intended approach, not yet feature complete
+  - [ ] Structural review of the classes, functions, and properties modified
+  - [ ] Final review
+
+For the pull request reviewer(s), this changeset has been reviewed for:
+
+- [ ] Consistency across platforms for structures or concepts added or modified
+- [ ] Consistency between the changeset and the goal stated above
+- [ ] Internal consistency with the rest of the library - is there any overlap between existing interfaces and any which have been added?
+- [ ] Usage friction - is the proposed change in usage cumbersome or complicated?
+- [ ] Performance and complexity - are there any cases of unexpected O(n^3) when iterating, recursing, flat mapping, etc?
+- [ ] Concurrency concerns - if components are accessed asynchronously, what issues will arise
+- [ ] Thoroughness of added tests and any missing edge cases
+- [ ] Idiomatic use of the language

data/CHANGELOG.md

@@ -1,6 +1,14 @@
 Changelog
 =========
 
+## 6.7.3 (18 May 2018)
+
+### Fixes
+
+* Apply metadata filters to HTTP referer fields
+  | [#460](https://github.com/bugsnag/bugsnag-ruby/pull/460)
+  | [Renee Balmert](https://github.com/tremlab)
+
 ## 6.7.2 (24 Apr 2018)
 
 ### Fixes

data/Gemfile

@@ -1,7 +1,7 @@
 source "https://rubygems.org"
 
 group :test, optional: true do
-    gem 'rake', '~> 10.1.1'
+    gem 'rake', RUBY_VERSION <= '1.9.3' ? '~> 11.3.0' : '~> 12.3.0'
     gem 'rspec'
     gem 'rspec-mocks'
     gem 'rdoc', '~> 5.1.0'

data/VERSION

@@ -1 +1 @@
-6.7.2
+6.7.3

data/lib/bugsnag/integrations/delayed_job.rb

@@ -30,7 +30,8 @@ unless defined? Delayed::Plugins::Bugsnag
               overrides[:job][:queue] = queue
             end
             if job.respond_to?(:attempts)
-              overrides[:job][:attempts] = "#{job.attempts + 1} / #{Delayed::Worker.max_attempts}"
+              max_attempts = job.respond_to?(:max_attempts) ? job.max_attempts : Delayed::Worker.max_attempts
+              overrides[:job][:attempts] = "#{job.attempts + 1} / #{max_attempts}"
               # +1 as "attempts" is really previous attempts AFAICT, certainly it starts at 0.
             end
             if payload = job.payload_object

data/lib/bugsnag/middleware/rack_request.rb

@@ -28,13 +28,22 @@ module Bugsnag::Middleware
         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 << Bugsnag::Cleaner.new(report.configuration.meta_data_filters).clean_url(request.fullpath)
+          url << 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
+        rescue StandardError => stde
+          Bugsnag.configuration.warn "RackRequest - Rescued error while cleaning request.referer: #{stde}"
+        end
+
         headers = {}
 
         env.each_pair do |key, value|
@@ -49,12 +58,14 @@ module Bugsnag::Middleware
           headers[header_key.split("_").map {|s| s.capitalize}.join("-")] = value
         end
 
+        headers["Referer"] = referer if headers["Referer"]
+
         # Add a request tab
         report.add_tab(:request, {
           :url => url,
           :httpMethod => request.request_method,
           :params => params.to_hash,
-          :referer => request.referer,
+          :referer => referer,
           :clientIp => client_ip,
           :headers => headers
         })

data/spec/bugsnag_spec.rb

@@ -33,7 +33,6 @@ describe Bugsnag do
     end
 
     it 'attempts to load integrations' do
-      Kernel::REQUIRED = []
       ENV["BUGSNAG_DISABLE_AUTOCONFIGURE"] = nil
       load "./lib/bugsnag.rb"
       Bugsnag::INTEGRATIONS.each do |integration|
@@ -42,36 +41,31 @@ describe Bugsnag do
     end
 
     it 'does not load integrations when BUGSNAG_DISABLE_AUTOCONFIGURE is true' do
-      Kernel::REQUIRED = []
       ENV["BUGSNAG_DISABLE_AUTOCONFIGURE"] = 'true'
       load "./lib/bugsnag.rb"
       expect(Kernel::REQUIRED).to eq(["bugsnag/integrations/rack"])
     end
 
     it 'loads all integrations if requested' do
-      Kernel::REQUIRED = []
-      expect(Kernel::REQUIRED).to eq([])
       Bugsnag.load_integrations
       Bugsnag::INTEGRATIONS.each do |integration|
         expect(Kernel::REQUIRED).to include("bugsnag/integrations/#{integration}")
       end
     end
 
-    it 'loads singular integrations' do
-      Kernel::REQUIRED = []
-      expect(Kernel::REQUIRED).to eq([])
-      Bugsnag::INTEGRATIONS.each do |integration|
-        Kernel::REQUIRED = []
+    Bugsnag::INTEGRATIONS.each do |integration|
+      it "loads #{integration}" do
         Bugsnag.load_integration(integration)
         expect(Kernel::REQUIRED).to include("bugsnag/integrations/#{integration}")
       end
     end
 
-    it 'loads railtie for :rails or :railtie' do
-      Kernel::REQUIRED = []
+    it 'loads railtie for rails' do
       Bugsnag.load_integration(:rails)
       expect(Kernel::REQUIRED).to include("bugsnag/integrations/railtie")
-      Kernel::REQUIRED = []
+    end
+
+    it 'loads railtie for railtie' do
       Bugsnag.load_integration(:railtie)
       expect(Kernel::REQUIRED).to include("bugsnag/integrations/railtie")
     end

data/spec/integration_spec.rb

@@ -57,10 +57,10 @@ describe 'Bugsnag' do
 
       Bugsnag.notify 'yo'
 
-      Process.fork do
+      pid = Process.fork do
         Bugsnag.notify 'yo too'
       end
-      Process.wait
+      Process.wait(pid)
 
       expect(queue.length).to eq(2)
     end

data/spec/integrations/delayed_job_spec.rb

@@ -4,12 +4,115 @@ require 'spec_helper'
 
 RSpec.describe ::Delayed::Plugins::Bugsnag do
   describe '#error' do
-    it 'should not raise exception' do
+    it 'should set metadata correctly with max_attempts' do
       payload = Object.new
       payload.extend(described_class::Notify)
+      job = double
+      allow(job).to receive_messages(
+        :id => "TEST",
+        :queue => "TEST_QUEUE",
+        :attempts => 0,
+        :max_attempts => 3,
+        :payload_object => {
+          :id => "PAYLOAD_ID",
+          :display_name => "PAYLOAD_DISPLAY_NAME",
+          :method_name => "PAYLOAD_METHOD_NAME",
+          :args => [
+            "SOME",
+            "TEST",
+            "ARGS"
+          ]
+        }
+      )
+
+      expect do
+        payload.error(job, '')
+      end.not_to raise_error
+
+      expect(Bugsnag).to have_sent_notification{ |payload, headers|
+        event = get_event_from_payload(payload)
+        expect(event["severity"]).to eq("error")
+        expect(event["severityReason"]).to eq({
+          "type" => "unhandledExceptionMiddleware",
+          "attributes" => {
+            "framework" => "DelayedJob"
+          }
+        })
+        expect(event["metaData"]["job"]).to eq({
+          "class" => job.class.name,
+          "id" => "TEST",
+          "queue" => "TEST_QUEUE",
+          "attempts" => "1 / 3",
+          "payload" => {
+            "class" => {}.class.name,
+            "args" => {
+              "id" => "PAYLOAD_ID",
+              "display_name" => "PAYLOAD_DISPLAY_NAME",
+              "method_name" => "PAYLOAD_METHOD_NAME",
+              "args" => [
+                "SOME",
+                "TEST",
+                "ARGS"
+              ]
+            }
+          }
+        })
+      }
+    end
+
+    it 'should set metadata correctly without max_attempts' do
+      payload = Object.new
+      payload.extend(described_class::Notify)
+      job = double
+      allow(job).to receive_messages(
+        :id => "TEST",
+        :queue => "TEST_QUEUE",
+        :attempts => 0,
+        :payload_object => {
+          :id => "PAYLOAD_ID",
+          :display_name => "PAYLOAD_DISPLAY_NAME",
+          :method_name => "PAYLOAD_METHOD_NAME",
+          :args => [
+            "SOME",
+            "TEST",
+            "ARGS"
+          ]
+        }
+      )
+
       expect do
-        payload.error(double('job', id: 1, payload_object: nil), '')
+        payload.error(job, '')
       end.not_to raise_error
+
+      expect(Bugsnag).to have_sent_notification{ |payload, headers|
+        event = get_event_from_payload(payload)
+        expect(event["severity"]).to eq("error")
+        expect(event["severityReason"]).to eq({
+          "type" => "unhandledExceptionMiddleware",
+          "attributes" => {
+            "framework" => "DelayedJob"
+          }
+        })
+        expect(event["metaData"]["job"]).to eq({
+          "class" => job.class.name,
+          "id" => "TEST",
+          "queue" => "TEST_QUEUE",
+          "attempts" => "1 / #{Delayed::Worker.max_attempts}",
+          "payload" => {
+            "class" => {}.class.name,
+            "args" => {
+              "id" => "PAYLOAD_ID",
+              "display_name" => "PAYLOAD_DISPLAY_NAME",
+              "method_name" => "PAYLOAD_METHOD_NAME",
+              "args" => [
+                "SOME",
+                "TEST",
+                "ARGS"
+              ]
+            }
+          }
+        })
+      }
     end
   end
 end

data/spec/integrations/rack_spec.rb

@@ -62,13 +62,74 @@ describe Bugsnag::Rack do
     before do
       unless defined?(::Rack)
         @mocked_rack = true
-        class ::Rack
-          class ::Request
+        class Rack
+          class Request
           end
         end
       end
     end
 
+    it "correctly redacts from url and referer any value indicated by meta_data_filters" do
+      callback = double
+      rack_env = {
+        :env => true,
+        :HTTP_REFERER => "https://bugsnag.com/about?email=hello@world.com&another_param=thing",
+        "rack.session" => {
+          :session => true
+        }
+      }
+
+      rack_request = double
+      rack_params = {
+        :param => 'test'
+      }
+      allow(rack_request).to receive_messages(
+        :params => rack_params,
+        :ip => "rack_ip",
+        :request_method => "TEST",
+        :path => "/TEST_PATH",
+        :scheme => "http",
+        :host => "test_host",
+        :port => 80,
+        :referer => "https://bugsnag.com/about?email=hello@world.com&another_param=thing",
+        :fullpath => "/TEST_PATH?email=hello@world.com&another_param=thing"
+      )
+      expect(::Rack::Request).to receive(:new).with(rack_env).and_return(rack_request)
+
+      # modify rack_env to include redacted referer
+      report = double("Bugsnag::Report")
+      allow(report).to receive(:request_data).and_return({
+        :rack_env => rack_env
+      })
+      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'])
+      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",
+        :httpMethod => "TEST",
+        :params => rack_params,
+        :referer => "https://bugsnag.com/about?email=[FILTERED]&another_param=thing",
+        :clientIp => "rack_ip",
+        :headers => {
+          "Referer" => "https://bugsnag.com/about?email=[FILTERED]&another_param=thing"
+        }
+      })
+      # rack_env["HTTP_REFERER"] = "https://bugsnag.com/about?email=[FILTERED]&another_param=thing"
+      expect(report).to receive(:add_tab).once.with(:environment, rack_env)
+      expect(report).to receive(:add_tab).once.with(:session, {
+        :session => true
+      })
+
+      expect(callback).to receive(:call).with(report)
+
+      middleware = Bugsnag::Middleware::RackRequest.new(callback)
+      middleware.call(report)
+    end
+
     it "correctly extracts data from rack middleware" do
       callback = double
       rack_env = {
@@ -78,7 +139,7 @@ describe Bugsnag::Rack do
           :session => true
         }
       }
-      
+
       rack_request = double
       rack_params = {
         :param => 'test'
@@ -94,7 +155,7 @@ describe Bugsnag::Rack do
         :referer => "referer",
         :fullpath => "/TEST_PATH"
       )
-      expect(::Rack::Request).to receive(:new).with(rack_env).and_return(rack_request)
+      expect(Rack::Request).to receive(:new).with(rack_env).and_return(rack_request)
 
       report = double("Bugsnag::Report")
       allow(report).to receive(:request_data).and_return({

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bugsnag
 version: !ruby/object:Gem::Version
-  version: 6.7.2
+  version: 6.7.3
 platform: ruby
 authors:
 - James Smith
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-24 00:00:00.000000000 Z
+date: 2018-05-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -33,6 +33,7 @@ extra_rdoc_files:
 - README.md
 - CHANGELOG.md
 files:
+- ".github/PULL_REQUEST_TEMPLATE.md"
 - ".gitignore"
 - ".rdoc_options"
 - ".rspec"
@@ -151,7 +152,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Ruby notifier for bugsnag.com