request-tracer 0.5.8 → 0.6.1

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ODhiNWZjMmY0OWNiNTk2YTMyYjIyMjMwMWI2NzVmN2M0MmIxZWM0ZQ==
+    MjI4YWIwMjlhZDY5ODZlMGI2OTBiZjJkNjY0YTUzNmUyNWNkODdhOQ==
   data.tar.gz: !binary |-
-    MDgyOGNiZjM3NjYxNGEzMmMyN2U0NTI4ZTA0N2M2ZTBmMTc0ODlhYg==
+    ZjAzNWJiYTczOTQxMzAyMWNkYzZiMDdjOTkwNTgzODUwY2EzYzQyNg==
 SHA512:
   metadata.gz: !binary |-
-    ZGVhYTBiM2MzNzJkMjc3MTVhOTc0MDQxZDc0ZmY4ODg3ODUyMmMyNzU5ZTYx
-    MGRmNGQ5OTU4ODI1MTNjODY1OWY0MDJjOGY4NGEwYTNmOTgwODhhMWE3NjNj
-    YWMxMTIwNzNlNjJiNWYzYjI2MWEzNTE2NTI2Njc0ZWUxYjE0OTE=
+    YWRjMzFmNTFkOGRlYjgwNjliM2JjZGRiYTE4Njk2YzhkZTBkOTJhZGNlYTNm
+    NjQ0ZTFlMTUzZmU1NTkwYzQwZjVlNDk4NTg3MjVmNzU0MmFjOGJhNDcxOWM5
+    MDlmZDk5M2VkMDNmNDJhMjAwZjhjNjg2OWVlY2VmNzc2YjNkNjc=
   data.tar.gz: !binary |-
-    MmU2YTc0NTFkMzE4MzczMWRlNmVjNDc5MWRhYmI0OWRlNDM5ZDRkMzBmMjVm
-    NWY3MDk4MzVkMmJmMDQ5ZmJmY2MxNzM0MzY0MGJiMGU5MjY2ZDY3NGNiNTcx
-    NjAxOTIxNTRhYTI4NTRjYWQzZjZlMDI2NTIyNDY2OTJjYzFjNTk=
+    YzU1YjlkYjEwNDI0ZjIyYjViMGFkM2JiOWY0NDhmOTdkZWIwODMxYTQ4YTFk
+    OWM0ODliNTczZWQyNDg5MDZkOTQwOWU1Zjc2MDBhOTMyMTQ2MDQ3MGIyMDI1
+    MWU1MzFkZDZjMzMxYTQ5ZGY3OWEyZTI2ODkwNzE5YzU4MDU3MDE=

data/lib/request_tracer/integration/sidekiq_handler.rb

@@ -0,0 +1,38 @@
+require_relative 'base'
+require_relative '../trace'
+module RequestTracer
+  module Integration
+    module SidekiqHandler
+      include Base
+      extend self
+      def activate
+        require 'sidekiq'
+        Sidekiq.configure_server do |config|
+          config.server_middleware do |chain|
+            chain.add ServerMiddleware
+          end
+        end
+        Sidekiq.configure_client do |config|
+          config.client_middleware do |chain|
+            chain.add ClientMiddleware
+          end
+        end
+      end
+
+      class ServerMiddleware
+        def call(worker, msg, queue)
+          Trace.push(msg["trace"]) do |trace|
+            yield
+          end
+        end
+      end
+
+      class ClientMiddleware
+        def call(worker_class, job, queue, redis_pool)
+          job['trace'] = Trace.latest.to_h
+          yield
+        end
+      end
+    end
+  end
+end

data/lib/request_tracer/trace.rb

@@ -94,6 +94,7 @@ module RequestTracer
     end
 
     def push(trace_info)
+      (yield ; return) unless trace_info
       trace = if trace_info.include?("trace_id") && trace_info.include?("span_id")
         TraceId.create(trace_info)
       else

data/lib/request_tracer/version.rb

@@ -1,3 +1,3 @@
 module RequestTracer
-  VERSION = "0.5.8"
+  VERSION = "0.6.1"
 end

data/request-tracer.gemspec

@@ -17,6 +17,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency 'rest-client'
+  spec.add_development_dependency 'sidekiq'
   spec.add_development_dependency 'bundler',     '~> 1.7'
   spec.add_development_dependency 'rake',        '~> 10.0'
   spec.add_development_dependency "rspec", "~> 3.4"

data/spec/lib/request_tracer/integration/sidekiq_handler_spec.rb

@@ -0,0 +1,115 @@
+require 'request_tracer/trace'
+require 'request_tracer/integration/sidekiq_handler'
+require 'sidekiq/testing'
+Sidekiq.logger = Logger.new('/tmp/sidekiq.log')
+
+
+describe RequestTracer::Integration::SidekiqHandler do
+  include RequestTracer::Integration::Base
+
+  class ResultChecker
+    attr_reader :traces, :job_args
+    def initialize
+      @traces = []
+      @job_args = []
+    end
+    def push_trace(trace)
+      @traces.push(trace)
+    end
+    def push_job_args(args)
+      @job_args.push(args)
+    end
+    def self.instance
+      @checker ||= self.new
+    end
+    def self.clear
+      @checker = nil
+    end
+  end
+
+  class TraceableJob
+    include Sidekiq::Worker
+    def perform(*args)
+      rc = ResultChecker.instance
+      rc.push_trace(RequestTracer::Trace.latest.to_h)
+      rc.push_job_args(args)
+    end
+  end
+
+  class ThreadSpawningMiddleware
+    def call(worker_instance, msg, queue, &blk)
+      result = nil
+      Thread.new { result = blk.call }.join
+      result
+    end
+  end
+
+  before(:all) do
+    Sidekiq::Testing.inline!
+  end
+
+  let(:result_checker) { ResultChecker.instance }
+  let(:trace) { RequestTracer::Trace.create }
+
+  before do
+    Sidekiq::Worker.clear_all
+    RequestTracer::Trace.clear
+    ResultChecker.clear
+  end
+
+  after do
+    Sidekiq::Testing.server_middleware {|chn| chn.clear }
+    Sidekiq.configure_client {|cfg|  cfg.client_middleware {|chn| chn.clear } }
+  end
+
+  context "when asynchronously calling a job with correctly setup middleware" do
+    before do
+      RequestTracer.integrate_with(:sidekiq)
+      Sidekiq::Testing.server_middleware do |chain|
+        chain.add ThreadSpawningMiddleware
+        chain.add RequestTracer::Integration::SidekiqHandler::ServerMiddleware
+      end
+    end
+    context "when there is an existing trace" do
+      before { RequestTracer::Trace.push trace.to_h }
+      it "passes the trace from the main process to the worker and records the worker" do
+        TraceableJob.perform_async('foo')
+        expect(result_checker.traces).to eq([trace.to_h])
+      end
+    end
+    it "calls the job with the originally given parameters" do
+      TraceableJob.perform_async(a_string: "bar", a_number: 12)
+      expect(result_checker.job_args).to eq([[{"a_string" => "bar", "a_number" => 12}]])
+    end
+  end
+  context "when asynchronously calling a job with missing server middleware" do
+    before do
+      RequestTracer.integrate_with(:sidekiq)
+      Sidekiq::Testing.server_middleware do |chain|
+        chain.add ThreadSpawningMiddleware
+      end
+    end
+    context "when there is an existing trace" do
+      before { RequestTracer::Trace.push trace.to_h }
+      it "passes the trace from the main process to the worker and records the worker" do
+        TraceableJob.perform_async('foo')
+        expect(result_checker.traces).to eq([{}])
+      end
+    end
+  end
+  context "when asynchronously calling a job with missing client middleware" do
+    before do
+      Sidekiq::Testing.server_middleware do |chain|
+        chain.add ThreadSpawningMiddleware
+        chain.add RequestTracer::Integration::SidekiqHandler::ServerMiddleware
+      end
+    end
+    context "when there is an existing trace" do
+      before { RequestTracer::Trace.push trace.to_h }
+      it "passes the trace from the main process to the worker and records the worker" do
+        TraceableJob.perform_async('foo')
+        expect(result_checker.traces).to eq([{}])
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: request-tracer
 version: !ruby/object:Gem::Version
-  version: 0.5.8
+  version: 0.6.1
 platform: ruby
 authors:
 - Martin Mauch
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-22 00:00:00.000000000 Z
+date: 2016-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -24,6 +24,20 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -213,12 +227,14 @@ files:
 - lib/request_tracer/integration/base.rb
 - lib/request_tracer/integration/rack_handler.rb
 - lib/request_tracer/integration/rest_client_handler.rb
+- lib/request_tracer/integration/sidekiq_handler.rb
 - lib/request_tracer/trace.rb
 - lib/request_tracer/version.rb
 - request-tracer.gemspec
 - spec/integration/integration_spec.rb
 - spec/lib/request_tracer/integration/rack_handler_spec.rb
 - spec/lib/request_tracer/integration/rest_client_handler_spec.rb
+- spec/lib/request_tracer/integration/sidekiq_handler_spec.rb
 - spec/lib/request_tracer/trace_spec.rb
 - spec/spec_helper.rb
 - spec/support/test_app.rb
@@ -251,6 +267,7 @@ test_files:
 - spec/integration/integration_spec.rb
 - spec/lib/request_tracer/integration/rack_handler_spec.rb
 - spec/lib/request_tracer/integration/rest_client_handler_spec.rb
+- spec/lib/request_tracer/integration/sidekiq_handler_spec.rb
 - spec/lib/request_tracer/trace_spec.rb
 - spec/spec_helper.rb
 - spec/support/test_app.rb