hoodoo 1.15.1 → 1.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1074a01d7b0b249400765334f2991cd5c00b9e85
-  data.tar.gz: 2e2473fbe2031ea3433a660e4a7bdc80a5012e03
+  metadata.gz: ab07823823bf92d1cfdd5070eb71585b95d7adbe
+  data.tar.gz: a9249d7aa4765ca5979eee0cf58d6919fc6f8a27
 SHA512:
-  metadata.gz: 89f72453d4d3ba63e7d22676864171272fb2a8fb6caf5c38704ca3993fbde88a3993f7e1f6cd70b6fa880ba2e439171b975cf33db6a27a91e81dd382de45092a
-  data.tar.gz: 3c1e9c6dc2e6f00955869055cee8f431364b3891fa72f68d2f7ca9dc6cfd6886d1501228d53aa2e95d4a7886362f193f96c2d4f77b7de8d3ba2c71fb30a57f6d
+  metadata.gz: 8fe35486b496e980d15d58cb2c353b86692833612a89cee9349b00bfac3fe5e54ae6cdb2fcd2591dd99454d66034e13b7fce01c6234c05ef0f5bcb7ea9dd0da1
+  data.tar.gz: 7101a2bc7914f19ab92fc338a74c16cb3f045b8d39985137dc177aae2bc1eb256a9f9af812be3eecd6eab78c2654302f853033c8bbf2bb88f7ab23e3767192fd

data/lib/hoodoo/client/endpoint/endpoints/amqp.rb

@@ -122,6 +122,7 @@ module Hoodoo
           #
           # * Hoodoo::Monkey
           # * Hoodoo::Monkey::Patch::NewRelicTracedAMQP
+          # * Hoodoo::Monkey::Patch::DatadogTracedAMQP
           #
           # +http_message+:: Hash describing the message to send.
           # +full_uri+::     Equivalent full URI of the request (information

data/lib/hoodoo/monkey.rb

@@ -12,3 +12,4 @@
 require 'hoodoo/monkey/monkey'
 require 'hoodoo/monkey/patch/newrelic_middleware_analytics'
 require 'hoodoo/monkey/patch/newrelic_traced_amqp'
+require 'hoodoo/monkey/patch/datadog_traced_amqp'

data/lib/hoodoo/monkey/patch/datadog_traced_amqp.rb

@@ -0,0 +1,89 @@
+########################################################################
+# File::    datadog_traced_amqp.rb
+# (C)::     Loyalty New Zealand 2017
+#
+# Purpose:: Extend the AMQP endpoint to support Datadog cross-app
+#           transaction tracing. Only defined and registered if the
+#           Datadog gem is available and Hoodooo Client is in scope.
+#
+#           See Hoodoo::Monkey::Patch::DatadogTracedAMQP for more.
+# ----------------------------------------------------------------------
+#           22-June-2017 (JRW): Created.
+########################################################################
+
+module Hoodoo
+  module Monkey
+    module Patch
+
+      begin
+        require 'ddtrace' # Raises LoadError if Datadog is absent
+
+        # Wrap Hoodoo::Client::Endpoint::AMQP using Datadog transaction
+        # tracing so that over-queue inter-resource calls get connected
+        # together in Datadogs's view of the world.
+        #
+        # This module self-registers with Hooodoo::Monkey and, provided
+        # that Hoodoo::Services::Middleware is defined at parse-time,
+        # will be enabled by default.
+        #
+        module DatadogTracedAMQP
+
+          # Instance methods to patch over Hoodoo::Client::Endpoint::AMQP.
+          #
+          module InstanceExtensions
+
+            # Wrap the request with Datadog's distributed tracing.
+            # This adds headers to the request and extracts header data from
+            # the response. It calls the original implementation via +super+.
+            #
+            # +http_message+:: Hash describing the message to send.
+            #
+            # +full_uri+::     URI being sent to. This is somewhat meaningless
+            #                  when using AMQP but NewRelic requires it.
+            #
+            def monkey_send_request( http_message, full_uri )
+              amqp_response = nil
+
+              Datadog.tracer.trace( 'alchemy.request' ) do |span|
+                span.service = 'alchemy'
+                span.span_type = 'alchemy'
+                span.resource = http_message[ 'verb' ]
+                span.set_tag( 'target.path', http_message[ 'path'] )
+
+                # Add Datadog trace IDs to the HTTP message
+                http_message[ 'headers' ][ 'X_DDTRACE_PARENT_TRACE_ID' ] = span.trace_id.to_s
+                http_message[ 'headers' ][ 'X_DDTRACE_PARENT_SPAN_ID' ] = span.span_id.to_s
+
+                amqp_response = super( http_message, full_uri )
+              end
+
+              return amqp_response
+            end
+          end
+        end
+
+        # Register this class with the Hoodoo monkey patch engine.
+        #
+        if defined?( Hoodoo::Client ) &&
+           defined?( Hoodoo::Client::Endpoint ) &&
+           defined?( Hoodoo::Client::Endpoint::AMQP )
+
+          Hoodoo::Monkey.register(
+              target_unit:      Hoodoo::Client::Endpoint::AMQP,
+              extension_module: Hoodoo::Monkey::Patch::DatadogTracedAMQP
+          )
+
+          if defined?( Hoodoo::Services ) &&
+             defined?( Hoodoo::Services::Middleware )
+
+            Hoodoo::Monkey.enable( extension_module: Hoodoo::Monkey::Patch::DatadogTracedAMQP )
+          end
+        end
+
+      rescue LoadError
+        # No Datadog => do nothing
+      end
+
+    end # module Patch
+  end   # module Monkey
+end     # module Hoodoo

data/lib/hoodoo/version.rb

@@ -12,6 +12,6 @@ module Hoodoo
   # The Hoodoo gem version. If this changes, ensure that the date in
   # "hoodoo.gemspec" is correct and run "bundle install" (or "update").
   #
-  VERSION = '1.15.1'
+  VERSION = '1.16.0'
 
 end

data/spec/ddtrace.rb

@@ -0,0 +1,17 @@
+########################################################################
+# File::    ddtrace.rb
+# (C)::     Loyalty New Zealand 2017
+#
+# Purpose:: Override Datadog 'require "ddtrace"'. The test suite
+#           cannot allow "real" Datadog to be loaded as this would hook
+#           into all kinds of things and interfere with test results,
+#           especially for tests covering variant behaviour for when
+#           Datadog is present or absent.
+# ----------------------------------------------------------------------
+#           22-June-2017 (JRW): Created.
+########################################################################
+
+# Yes, this is empty, just comments. The whole point is to allow code to
+# be able to require what it thinks is Datadog without a LoadError
+# exception being raised, but not actually define any Datadog components
+# until the test suite is good and ready to do so (with mock data).

data/spec/monkey/patch/datadog_traced_amqp_spec.rb

@@ -0,0 +1,63 @@
+require 'spec_helper.rb'
+
+# We need to run these tests in order. First a bunch of shared examples
+# run. Then we check to see if hook methods were invoked in passing. You
+# can't do that in an 'after' hook as exceptions therein cause warnings
+# to be printed, but don't cause test failures.
+#
+describe Hoodoo::Monkey::Patch::DatadogTracedAMQP, :order => :defined do
+
+  # Not every test in the 'an AMQP-based middleware/client endpoint' shared
+  # example group will provoke a request. We cannot expect to have the
+  # NewRelic hooks called for every example. We *can* expect them to be
+  # called several times though, so use 'allow' to track those calls and
+  # count them.
+  #
+  before :all do
+    @@endpoint_do_amqp_count  = 0
+    @@datadog_trace_count     = 0
+
+    # Stub Datadog
+    class Datadog
+      def self.tracer
+        Datadog.new
+      end
+    end
+
+    Hoodoo::Monkey.enable( extension_module: Hoodoo::Monkey::Patch::DatadogTracedAMQP )
+  end
+
+  after :all do
+    Hoodoo::Monkey.disable( extension_module: Hoodoo::Monkey::Patch::DatadogTracedAMQP )
+    Object.send( :remove_const, :Datadog )
+  end
+
+  before :each do
+    expect( Hoodoo::Client::Endpoint::AMQP.ancestors ).to include( Hoodoo::Monkey::Patch::DatadogTracedAMQP::InstanceExtensions )
+
+    original_do_amqp = Hoodoo::Client::Endpoint::AMQP.instance_method( :do_amqp )
+
+    allow_any_instance_of( Hoodoo::Client::Endpoint::AMQP ).to receive( :do_amqp ) do | instance, description_of_request |
+      result = original_do_amqp.bind( instance ).call( description_of_request )
+      @@endpoint_do_amqp_count += 1
+      result
+    end
+
+    allow_any_instance_of( Datadog ).to receive( :trace ) do | &block |
+      # Datadog Trace method responds with a yielded span this is here to mock tha
+      span = double('span', trace_id: 'trace_id', span_id: 'span_id').as_null_object
+      @@datadog_trace_count += 1
+      block.call(span)
+    end
+  end
+
+  it_behaves_like 'an AMQP-based middleware/client endpoint',
+                  {'X_DDTRACE_PARENT_TRACE_ID'=>'trace_id', 'X_DDTRACE_PARENT_SPAN_ID' => 'span_id'}
+
+  context 'afterwards' do
+    it 'has non-zero NewRelic method call counts' do
+      expect( @@endpoint_do_amqp_count ).to be > 5
+      expect( @@datadog_trace_count ).to eq( @@endpoint_do_amqp_count )
+    end
+  end
+end

data/spec/services/middleware/middleware_exotic_communication_spec.rb

@@ -8,6 +8,7 @@ describe Hoodoo::Services::Middleware do
 
   context 'on queue' do
     before :all do
+      Hoodoo::Monkey.disable( extension_module: Hoodoo::Monkey::Patch::DatadogTracedAMQP )
       Hoodoo::Monkey.disable( extension_module: Hoodoo::Monkey::Patch::NewRelicTracedAMQP )
     end
 

data/spec/services/middleware/middleware_multi_local_spec.rb

@@ -437,8 +437,8 @@ describe Hoodoo::Services::Middleware::InterResourceLocal do
   it 'manages ActiveRecord when implementation is called in its presence' do
     pool = ActiveRecord::Base.connection_pool
 
-    expect( ActiveRecord::Base ).to receive( :connection_pool ).twice.and_call_original
-    expect( pool               ).to receive( :with_connection ).twice.and_call_original
+    expect( ActiveRecord::Base ).to receive( :connection_pool ).exactly( 3 ).times.and_call_original
+    expect( pool               ).to receive( :with_connection ).exactly( 2 ).times.and_call_original
 
     list_things()
   end

data/spec/shared_examples/middleware_amqp.rb

@@ -16,8 +16,10 @@ class RSpecTestServiceExoticStub < Hoodoo::Services::Service
   comprised_of RSpecTestServiceExoticStubInterface
 end
 
-shared_examples 'an AMQP-based middleware/client endpoint' do
+# Optional extra header hash is for middleware that intentionally adds headers
+shared_examples 'an AMQP-based middleware/client endpoint' do |optional_extra_header_hash|
   before :each do
+    @optional_extra_header_hash = optional_extra_header_hash || {}
     @old_queue = ENV[ 'AMQ_URI' ]
     ENV[ 'AMQ_URI' ] = 'amqp://test:test@127.0.0.1'
     @mw = Hoodoo::Services::Middleware.new( RSpecTestServiceExoticStub.new )
@@ -103,7 +105,7 @@ shared_examples 'an AMQP-based middleware/client endpoint' do
             'Accept-Language' => 'fr',
             'X-Interaction-ID' => @interaction.interaction_id,
             'X-Session-ID' => @interaction.context.session.session_id
-          },
+          }.merge!( @optional_extra_header_hash ),
         } )
       end.and_return( mock_response )
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hoodoo
 version: !ruby/object:Gem::Version
-  version: 1.15.1
+  version: 1.16.0
 platform: ruby
 authors:
 - Loyalty New Zealand
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-18 00:00:00.000000000 Z
+date: 2017-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dalli
@@ -156,14 +156,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.0
+        version: '1.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.0
+        version: '1.6'
 - !ruby/object:Gem::Dependency
   name: pg
   requirement: !ruby/object:Gem::Requirement
@@ -317,6 +317,7 @@ files:
 - lib/hoodoo/middleware.rb
 - lib/hoodoo/monkey.rb
 - lib/hoodoo/monkey/monkey.rb
+- lib/hoodoo/monkey/patch/datadog_traced_amqp.rb
 - lib/hoodoo/monkey/patch/newrelic_middleware_analytics.rb
 - lib/hoodoo/monkey/patch/newrelic_traced_amqp.rb
 - lib/hoodoo/presenters.rb
@@ -417,6 +418,7 @@ files:
 - spec/data/types/permissions_full_spec.rb
 - spec/data/types/permissions_resources_spec.rb
 - spec/data/types/permissions_spec.rb
+- spec/ddtrace.rb
 - spec/errors/error_descriptions_spec.rb
 - spec/errors/errors_spec.rb
 - spec/files/regenerate.rb
@@ -428,6 +430,7 @@ files:
 - spec/logger/writers/log_entries_dot_com_writer_spec.rb
 - spec/logger/writers/stream_writer_spec.rb
 - spec/monkey/monkey_spec.rb
+- spec/monkey/patch/datadog_traced_amqp_spec.rb
 - spec/monkey/patch/newrelic_middleware_analytics_spec.rb
 - spec/monkey/patch/newrelic_traced_amqp_spec.rb
 - spec/new_relic/agent/method_tracer.rb
@@ -560,6 +563,7 @@ test_files:
 - spec/data/types/permissions_full_spec.rb
 - spec/data/types/permissions_resources_spec.rb
 - spec/data/types/permissions_spec.rb
+- spec/ddtrace.rb
 - spec/errors/error_descriptions_spec.rb
 - spec/errors/errors_spec.rb
 - spec/files/regenerate.rb
@@ -571,6 +575,7 @@ test_files:
 - spec/logger/writers/log_entries_dot_com_writer_spec.rb
 - spec/logger/writers/stream_writer_spec.rb
 - spec/monkey/monkey_spec.rb
+- spec/monkey/patch/datadog_traced_amqp_spec.rb
 - spec/monkey/patch/newrelic_middleware_analytics_spec.rb
 - spec/monkey/patch/newrelic_traced_amqp_spec.rb
 - spec/new_relic/agent/method_tracer.rb