bugsnag 6.11.0 → 6.11.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fc8a84dd1c666154aabc8e2a259f195e002b536d65c26c7e2a4399f988da37c0
-  data.tar.gz: c57acd7af26a27dcdc8649d8822f707f146f77d02fa01356941cf4cd4f9d8293
+  metadata.gz: 4fc49d1de25e741d85e743661a97ed65c14b4c147f6d2ddb5ce80be233aae244
+  data.tar.gz: b67ad9235232b3eb001475a07cc1698ee44b2c48c6c59acfffda4b88a20ad4c5
 SHA512:
-  metadata.gz: f1af419ae0b0fdc8b6284463a2945369564b5af5255aaeda4141f197787972d3483514a4db99e2a5dc9b6cba50ebd237bcdfe5509b738772954c25acdaa7582e
-  data.tar.gz: 845838f4f41b3893b95067437825c9af1ab4e634194d0cd81276784fde73e6227d1665da89c68d15e40181c257ec23eab7c857ff77225a9cfd52a7d1bbffb75d
+  metadata.gz: f87742900794a8a7bfc442d80b57366360d00b57e4c1e55667b62d9ee669610b2c35ebd94edacd86526b0b88137df99838f5db3ee54ad8efccd2cfbec1cb1f14
+  data.tar.gz: 6520b4f661659dacd4ce54acf4a0c75a3815dbe7f667343e377639a5d90d39f3b0e9cc7ab054032a22be50e5c846ad64719c9fb23882840e521dc88602887e9e

data/CHANGELOG.md

@@ -1,6 +1,13 @@
 Changelog
 =========
 
+## 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.

data/VERSION

@@ -1 +1 @@
-6.11.0
+6.11.1

data/lib/bugsnag/breadcrumbs/validator.rb

@@ -17,7 +17,7 @@ module Bugsnag::Breadcrumbs
     def validate(breadcrumb)
       # Check name length
       if breadcrumb.name.size > Bugsnag::Breadcrumbs::MAX_NAME_LENGTH
-        @configuration.warn("Breadcrumb name trimmed to length #{Bugsnag::Breadcrumbs::MAX_NAME_LENGTH}.  Original name: #{breadcrumb.name}")
+        @configuration.debug("Breadcrumb name trimmed to length #{Bugsnag::Breadcrumbs::MAX_NAME_LENGTH}.  Original name: #{breadcrumb.name}")
         breadcrumb.name = breadcrumb.name.slice(0...Bugsnag::Breadcrumbs::MAX_NAME_LENGTH)
       end
 
@@ -26,21 +26,21 @@ module Bugsnag::Breadcrumbs
         if valid_meta_data_type?(v)
           true
         else
-          @configuration.warn("Breadcrumb #{breadcrumb.name} meta_data #{k}:#{v} has been dropped for having an invalid data type")
+          @configuration.debug("Breadcrumb #{breadcrumb.name} meta_data #{k}:#{v.class} has been dropped for having an invalid data type")
           false
         end
       end
 
       # Check type is valid, set to manual otherwise
       unless Bugsnag::Breadcrumbs::VALID_BREADCRUMB_TYPES.include?(breadcrumb.type)
-        @configuration.warn("Invalid type: #{breadcrumb.type} for breadcrumb: #{breadcrumb.name}, defaulting to #{Bugsnag::Breadcrumbs::MANUAL_BREADCRUMB_TYPE}")
+        @configuration.debug("Invalid type: #{breadcrumb.type} for breadcrumb: #{breadcrumb.name}, defaulting to #{Bugsnag::Breadcrumbs::MANUAL_BREADCRUMB_TYPE}")
         breadcrumb.type = Bugsnag::Breadcrumbs::MANUAL_BREADCRUMB_TYPE
       end
 
       # If auto is true, check type is in enabled_automatic_breadcrumb_types
       return unless breadcrumb.auto && !@configuration.enabled_automatic_breadcrumb_types.include?(breadcrumb.type)
 
-      @configuration.warn("Automatic breadcrumb of type #{breadcrumb.type} ignored: #{breadcrumb.name}")
+      @configuration.debug("Automatic breadcrumb of type #{breadcrumb.type} ignored: #{breadcrumb.name}")
       breadcrumb.ignore!
     end
 

data/lib/bugsnag/integrations/rails/rails_breadcrumbs.rb

@@ -22,7 +22,6 @@ module Bugsnag::Rails
       :message => "Read cache",
       :type => Bugsnag::Breadcrumbs::PROCESS_BREADCRUMB_TYPE,
       :allowed_data => [
-        :key,
         :hit,
         :super_operation
       ]
@@ -31,9 +30,7 @@ module Bugsnag::Rails
       :id => "cache_fetch_hit.active_support",
       :message => "Fetch cache hit",
       :type => Bugsnag::Breadcrumbs::PROCESS_BREADCRUMB_TYPE,
-      :allowed_data => [
-        :key
-      ]
+      :allowed_data => []
     },
     {
       :id => "sql.active_record",

data/spec/breadcrumbs/validator_spec.rb

@@ -26,7 +26,7 @@ RSpec.describe Bugsnag::Breadcrumbs::Validator do
       })
 
       expect(breadcrumb).to_not receive(:ignore!)
-      expect(config).to_not receive(:warn)
+      expect(config).to_not receive(:debug)
 
       validator.validate(breadcrumb)
     end
@@ -49,7 +49,7 @@ RSpec.describe Bugsnag::Breadcrumbs::Validator do
       expect(breadcrumb).to_not receive(:ignore!)
       expect(breadcrumb).to receive(:name=).with("123456789012345678901234567890")
       expected_string = "Breadcrumb name trimmed to length 30.  Original name: #{name}"
-      expect(config).to receive(:warn).with(expected_string)
+      expect(config).to receive(:debug).with(expected_string)
 
       validator.validate(breadcrumb)
       # Check the original message has not been modified
@@ -80,7 +80,7 @@ RSpec.describe Bugsnag::Breadcrumbs::Validator do
         })
 
         expect(breadcrumb).to_not receive(:ignore!)
-        expect(config).to_not receive(:warn)
+        expect(config).to_not receive(:debug)
 
         validator.validate(breadcrumb)
       end
@@ -110,12 +110,12 @@ RSpec.describe Bugsnag::Breadcrumbs::Validator do
         })
 
         expect(breadcrumb).to_not receive(:ignore!)
-        expected_string_1 = "Breadcrumb #{breadcrumb.name} meta_data array:#{meta_data[:array]} has been dropped for having an invalid data type"
-        expected_string_2 = "Breadcrumb #{breadcrumb.name} meta_data hash:#{meta_data[:hash]} has been dropped for having an invalid data type"
-        expected_string_3 = "Breadcrumb #{breadcrumb.name} meta_data object:#{ meta_data[:object]} has been dropped for having an invalid data type"
-        expect(config).to receive(:warn).with(expected_string_1)
-        expect(config).to receive(:warn).with(expected_string_2)
-        expect(config).to receive(:warn).with(expected_string_3)
+        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({
@@ -144,7 +144,7 @@ RSpec.describe Bugsnag::Breadcrumbs::Validator do
       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(:warn).with(expected_string)
+      expect(config).to receive(:debug).with(expected_string)
 
       validator.validate(breadcrumb)
     end
@@ -169,7 +169,7 @@ RSpec.describe Bugsnag::Breadcrumbs::Validator do
 
         expect(breadcrumb).to receive(:ignore!)
         expected_string = "Automatic breadcrumb of type #{Bugsnag::Breadcrumbs::ERROR_BREADCRUMB_TYPE} ignored: #{breadcrumb.name}"
-        expect(config).to receive(:warn).with(expected_string)
+        expect(config).to receive(:debug).with(expected_string)
 
         validator.validate(breadcrumb)
       end
@@ -191,7 +191,7 @@ RSpec.describe Bugsnag::Breadcrumbs::Validator do
         })
 
         expect(breadcrumb).to_not receive(:ignore!)
-        expect(config).to_not receive(:warn)
+        expect(config).to_not receive(:debug)
 
         validator.validate(breadcrumb)
       end

data/spec/session_tracker_spec.rb

@@ -2,14 +2,6 @@
 require 'webrick'
 require 'spec_helper'
 require 'json'
-require 'concurrent'
-
-# Enable reset of session_counts between each example
-module Bugsnag
-  class SessionTracker
-    attr_accessor :session_counts
-  end
-end
 
 describe Bugsnag::SessionTracker do
   server = nil
@@ -27,7 +19,7 @@ describe Bugsnag::SessionTracker do
     Thread.new{ server.start }
   end
 
-  after(:each) do
+  before(:each) do
     Bugsnag.instance_variable_set(:@session_tracker, Bugsnag::SessionTracker.new)
   end
 
@@ -40,6 +32,10 @@ describe Bugsnag::SessionTracker do
     queue.clear
   end
 
+  after(:all) do
+    Bugsnag.instance_variable_set(:@session_tracker, Bugsnag::SessionTracker.new)
+  end
+
   it 'adds session object to queue' do
     tracker = Bugsnag::SessionTracker.new
     tracker.start_session

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bugsnag
 version: !ruby/object:Gem::Version
-  version: 6.11.0
+  version: 6.11.1
 platform: ruby
 authors:
 - James Smith
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-17 00:00:00.000000000 Z
+date: 2019-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby