hoodoo 2.1.2 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 27c91b7d6239a85430ddf6e2cb47e0461775375e6f4b1969c6bbbf9017a41243
-  data.tar.gz: 3808aceb6a8474d1c456d25b38aa5a280df7c6da547747f1a54cce3b57bbe1ab
+  metadata.gz: 27f8a7c4aed490d7d8e01fb68469c393b094e1d83ab1100a700e330c2288e88d
+  data.tar.gz: ebf5032d0056a507db7bbaf63b51269469350e5e2189b5016d06a1012c88dd7d
 SHA512:
-  metadata.gz: 35bea308563fef3c91d9f5f015942b3a03a198a299a18f754079d8ed1319cfc7da10165deee81d356064bcf1f479e5d20958807b9a7f90a998a3d288291d25b0
-  data.tar.gz: 072047f7dc3c8deccb4a034de3bd793149909e99107455125313ae92f4ce85b059cf90b11ad3587af4b85a86c2199f235180f592b54bded4891ebc97a0802f4e
+  metadata.gz: 39ffe6dc1b31ff93b3cf5fb6424a253d107d7a9c4c1aeae789d8c04d6e6ebbec06dde7b42f9b411875b55d0722bc6571e9eb3432a148a8ac8b610dc1b96310b2
+  data.tar.gz: 44a537dcdcf8e7b905a4ac933a2497bd2c14598e2017b63b207baed5fcab4fdd511f17117b5a7a99e27f540f6745c5ade28eac50b4acd50d6354ab8a1c5bf5ee

data/lib/hoodoo/services/middleware/exception_reporting/reporters/airbrake_reporter.rb

@@ -57,6 +57,8 @@ module Hoodoo; module Services
         def report( e, env )
           opts = { :backtrace => Kernel.caller() }
           opts[ :rack_env ] = env unless env.nil?
+          e    = sanitize_object(e)
+          opts = sanitize_object(opts)
 
           # Since an ExceptionReporter is already a "slow communicatory",
           # Hoodoo is using threads for behaviour; we don't need the async
@@ -81,9 +83,37 @@ module Hoodoo; module Services
             :environment_name => Hoodoo::Services::Middleware.environment,
             :session          => user_data_for( context ) || 'unknown'
           }
+          e    = sanitize_object(e)
+          opts = sanitize_object(opts)
 
           Airbrake.notify_sync( e, opts )
         end
+
+        private
+
+        # Recursive sanitisation method for deeply nested hash objects, returning
+        # the same object in a non frozen state.
+        #
+        # Why do I exist?
+        #
+        # Due to an airbrake-ruby issue where client arguments can be mutated when within a hash,
+        # a recursive sanitisation process must therefore take place before our inputs are sent
+        # to Airbrake, ensuring no frozen hash objects are present.
+        #
+        # https://github.com/airbrake/airbrake-ruby/issues/281
+        #
+        def sanitize_object( object )
+          object = ( object.dup rescue object ) if object.frozen?
+          return object unless object.is_a?( Hash )
+
+          sanitize_hash( object )
+        end
+
+        def sanitize_hash( object )
+          object.each do | key, value |
+            object[key] = sanitize_object( value )
+          end
+        end
       end
 
     end

data/lib/hoodoo/version.rb

@@ -12,11 +12,11 @@ module Hoodoo
   # The Hoodoo gem version. If this changes, be sure to re-run
   # <tt>bundle install</tt> or <tt>bundle update</tt>.
   #
-  VERSION = '2.1.2'
+  VERSION = '2.2.0'
 
   # The Hoodoo gem date. If this changes, be sure to re-run
   # <tt>bundle install</tt> or <tt>bundle update</tt>.
   #
-  DATE = '2017-11-07'
+  DATE = '2017-11-09'
 
 end

data/spec/services/middleware/exception_reporting/reporters/airbrake_reporter_spec.rb

@@ -16,33 +16,104 @@ describe Hoodoo::Services::Middleware::ExceptionReporting::AirbrakeReporter do
   end
 
   context '#report' do
-    it 'calls Airbrake correctly without an "env"' do
-      ex = RuntimeError.new( 'A' )
-
-      expect( Airbrake ).to receive( :notify_sync ).once do | e, opts |
-        expect( e ).to be_a( Exception )
-        expect( opts ).to be_a( Hash )
-        expect( opts ).to have_key( :backtrace )
-        expect( opts ).to_not have_key( :rack_env )
+    context 'with Airbrake mocks' do
+      it 'calls Airbrake correctly without an "env"' do
+        ex = RuntimeError.new( 'A' )
+
+        expect( Airbrake ).to receive( :notify_sync ).once do | e, opts |
+          expect( e ).to be_a( Exception )
+          expect( opts ).to be_a( Hash )
+          expect( opts ).to have_key( :backtrace )
+          expect( opts ).to_not have_key( :rack_env )
+        end
+
+        Hoodoo::Services::Middleware::ExceptionReporting.report( ex )
       end
 
-      Hoodoo::Services::Middleware::ExceptionReporting.report( ex )
+      it 'calls Airbrake correctly with an "env"' do
+        ex       = RuntimeError.new( 'A' )
+        mock_env = { 'rack' => 'request' }
+
+        expect( Airbrake ).to receive( :notify_sync ).once do | e, opts |
+          expect( e ).to be_a( Exception )
+
+          expect( opts ).to be_a( Hash )
+          expect( opts ).to have_key( :backtrace )
+
+          expect( opts[ :rack_env ] ).to eq( mock_env )
+        end
+
+        Hoodoo::Services::Middleware::ExceptionReporting.report( ex, mock_env )
+      end
     end
 
-    it 'calls Airbrake correctly with an "env"' do
-      ex       = RuntimeError.new( 'A' )
-      mock_env = { 'rack' => 'request' }
+    context 'without Airbrake mocks' do
+
+      # Airbrake does not allow the default notifier to be reconfigured, so we
+      # must set some dummy values here just once within this Airbrake-specific
+      # integration test. Without this, non-mocked tests do not run much of the
+      # Airbrake code that, over time, we have discovered should be tested.
+      #
+      before :all do
+        Airbrake.configure do | config |
+          config.project_id  = '123456'
+          config.project_key = Hoodoo::UUID.generate()
+        end
+      end
 
-      expect( Airbrake ).to receive( :notify_sync ).once do | e, opts |
-        expect( e ).to be_a( Exception )
+      before :each do
+        WebMock.enable!
 
-        expect( opts ).to be_a( Hash )
-        expect( opts ).to have_key( :backtrace )
+        stub_request( :post,   /airbrake\.io\/api/ ).
+           to_return( :body    => "{}",
+                      :status  => 201,
+                      :headers => { 'Content-Length' => 2 } )
+      end
+
+      after :each do
+        WebMock.reset!
+        WebMock.disable!
+      end
+
+      it 'can send frozen exceptions' do
+        ex = RuntimeError.new( 'A' )
+
+        # Be sure that the adaptero called Airbrake and that Airbrake did try
+        # to internally send the message (which we'll catch with WebMock via
+        # the "before :each" filter above).
+        #
+        expect( Airbrake ).to receive( :notify_sync ).once.and_call_original
+        expect_any_instance_of( Airbrake::SyncSender ).to receive( :send ).once.and_call_original
 
-        expect( opts[ :rack_env ] ).to eq( mock_env )
+        # There shouldn't be any need to handle exceptions inside the
+        # communicator pool underneath the adaptor.
+        #
+        expect_any_instance_of( Hoodoo::Communicators::Pool ).to_not receive( :handle_exception )
+
+        Hoodoo::Services::Middleware::ExceptionReporting.report( ex.freeze() )
+        Hoodoo::Services::Middleware::ExceptionReporting.wait()
       end
 
-      Hoodoo::Services::Middleware::ExceptionReporting.report( ex, mock_env )
+      it 'can send frozen data large enough to require truncation' do
+        ex       = RuntimeError.new( 'A' )
+        mock_env = { 'rack' => 'request' }
+
+        1.upto( Airbrake::Notice::PAYLOAD_MAX_SIZE + 10 ) do | i |
+          mock_env[ Hoodoo::UUID.generate() ] = i
+        end
+
+        # See previous test (above) for an explanation of the expectations
+        # below.
+
+        expect( Airbrake ).to receive( :notify_sync ).once.and_call_original
+        expect_any_instance_of( Airbrake::Truncator ).to receive( :truncate_object ).at_least( :once ).and_call_original
+        expect_any_instance_of( Airbrake::SyncSender ).to receive( :send ).once.and_call_original
+
+        expect_any_instance_of( Hoodoo::Communicators::Pool ).to_not receive( :handle_exception )
+
+        Hoodoo::Services::Middleware::ExceptionReporting.report( ex, mock_env.freeze() )
+        Hoodoo::Services::Middleware::ExceptionReporting.wait()
+      end
     end
   end
 

data/spec/spec_helper.rb

@@ -19,6 +19,16 @@ end
 
 require 'byebug'
 
+# Stubbing Net::HTTP with WebMock - disabled by default; only enable for
+# tests where you need it, as real Net::HTTP connections are used in many
+# other tests and must not be mocked.
+#
+# https://github.com/bblimke/webmock
+
+require 'webmock/rspec'
+
+WebMock.disable!
+
 # The ActiveRecord extensions need testing in the context of a database. I
 # did consider NullDB - https://github.com/nulldb/nulldb - but this was too
 # far from 'the real thing' for my liking. Instead, we use SQLite in memory

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hoodoo
 version: !ruby/object:Gem::Version
-  version: 2.1.2
+  version: 2.2.0
 platform: ruby
 authors:
 - Loyalty New Zealand
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-07 00:00:00.000000000 Z
+date: 2017-11-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dalli
@@ -122,6 +122,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -212,28 +226,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '2.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '2.6'
 - !ruby/object:Gem::Dependency
   name: airbrake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.2'
+        version: '7.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.2'
+        version: '7.1'
 - !ruby/object:Gem::Dependency
   name: le
   requirement: !ruby/object:Gem::Requirement
@@ -518,7 +532,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.2.7
+      version: 2.2.8
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -526,7 +540,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.1
+rubygems_version: 2.7.2
 signing_key: 
 specification_version: 4
 summary: Opinionated APIs